mirror of
https://github.com/wagtail/wagtail.git
synced 2024-11-30 01:46:24 +01:00
| .. | ||
| _static/css | ||
| building_your_site | ||
| editor_manual | ||
| images | ||
| advanced_topics.rst | ||
| autobuild.sh | ||
| conf.py | ||
| contributing.rst | ||
| deploying.rst | ||
| editing_api.rst | ||
| form_builder.rst | ||
| frontend_cache_purging.rst | ||
| gettingstarted.rst | ||
| index.rst | ||
| Makefile | ||
| management_commands.rst | ||
| model_recipes.rst | ||
| performance.rst | ||
| README.md | ||
| roadmap.rst | ||
| settings.rst | ||
| sitemap_generation.rst | ||
| snippets.rst | ||
| static_site_generation.rst | ||
| support.rst | ||
| wagtail_search.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 Sphinx and the RTD theme:
pip install Sphinx
pip install sphinx-rtd-theme
Then make html from this directory, and open _build/html/index.html in your browser.
We've provided a watchdog script (based on @jacobian's snippet) to auto-build your local docs when you save them. Install watchdog:
pip install watchdog
Then run ./autobuild.sh before you start editing.
The online editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.