mirror of
https://github.com/Hopiu/wagtail.git
synced 2026-04-08 00:51:10 +00:00
3c44037b2f
* Fix "Duplicate explicit target name" warnings on extending_draftail.rst ref: https://github.com/sphinx-doc/sphinx/issues/3921 * Fix 'Unknown target name' warning on third_party_tutorials.rst * Add docstrings to Page.get_ancestors, get_descendants and get_siblings Documents the `inclusive` flag and avoids the "Field list ends without a blank line; unexpected unindent" warning when building docs |
||
|---|---|---|
| .. | ||
| _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 http://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.