mirror of
https://github.com/Hopiu/wagtail.git
synced 2026-03-17 06:20:31 +00:00
43acf24cc8
The CHANGELOG docs say that contributor names should only be included if they are not a core committer, but historical practice has been to always include names. Per discussion on the core team, we want to change this guidance to explicitly recommend always including contributor names. This not only encourages and recognizes contributions but also helps future contributors know who worked on different parts of the code. This record (along with git history) provides a good reference to understand who made certain changes or features. |
||
|---|---|---|
| .. | ||
| _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.