kopia lustrzana https://github.com/wagtail/wagtail
![]() * Split `helpers.py` into separate `url.py`, `permission.py` and `button.py`, dedicated to those separate concerns and update the docs accordingly * Move `ThumbnailMixin` out to `mixins.py` and update documentation accordingly * Ad #NOQA to import lines to hush pep errors * Alphabetise helper import order * - Delete `helpers/helpers.py` - wagtal -> wagtail in docs |
||
---|---|---|
.. | ||
_static/images | ||
advanced_topics | ||
contributing | ||
editor_manual | ||
getting_started | ||
reference | ||
releases | ||
topics | ||
Makefile | ||
README.md | ||
autobuild.sh | ||
conf.py | ||
index.rst | ||
logo.png | ||
requirements.txt | ||
spelling_wordlist.txt | ||
support.rst |
README.md
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.