mirror of
https://github.com/wagtail/wagtail.git
synced 2024-11-29 17:36:49 +01:00
17e09fee76
Building the docs currently generates a warning: wagtail/docs/reference/contrib/modeladmin/indexview.rst:423: WARNING: Could not lex literal_block as "python". Highlighting skipped. This is due to use of backticks instead of single quotes on this page: https://docs.wagtail.io/en/v2.8/reference/contrib/modeladmin/indexview.html#modeladmin-get-queryset In practice this doesn't seem to actually break highlighting, but it's still good to fix. |
||
|---|---|---|
| .. | ||
| _static | ||
| advanced_topics | ||
| contributing | ||
| editor_manual | ||
| getting_started | ||
| reference | ||
| releases | ||
| topics | ||
| autobuild.sh | ||
| conf.py | ||
| favicon.ico | ||
| index.rst | ||
| logo.png | ||
| Makefile | ||
| README.md | ||
| requirements.txt | ||
| spelling_wordlist.txt | ||
| support.rst | ||
Wagtail docs
These are Sphinx docs, automatically built at https://docs.wagtail.io when the master branch is committed to Github. To build them locally, install Wagtail's development requirements (in the root Wagtail directory):
pip install -e .[testing,docs]
To build the documentation for browsing, from this directory run:
make html
then open _build/html/index.html in a browser.
To rebuild automatically while editing the documentation, from this directory run:
sphinx-autobuild . _build
The online editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.