0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 11:10:43 +01:00
wagtail/docs
2021-02-26 10:04:35 +00:00
..
_static Move labels above the form field in the image format chooser 2021-02-26 09:19:20 +00:00
_templates Insert Plausible.io analytics code into docs 2021-02-18 18:14:10 +00:00
advanced_topics Fix documentation indentation 2021-02-26 09:17:00 +00:00
contributing Fix documentation indentation 2021-02-26 09:17:00 +00:00
editor_manual Fix documentation indentation 2021-02-26 09:17:00 +00:00
getting_started Reapply file extension change 2021-02-26 09:27:59 +00:00
reference Fix documentation indentation 2021-02-26 09:17:00 +00:00
releases Fix bullet liest formatting 2021-02-26 10:04:35 +00:00
topics Fix documentation indentation 2021-02-26 09:17:00 +00:00
autobuild.sh
conf.py Configure Sphinx for Markdown support (#6711) 2021-01-26 22:09:52 +00:00
favicon.ico
index.rst Move "writing documentation" page into Contributing (#6789) 2021-02-05 09:29:03 -05:00
logo.png
Makefile Fix broken "make livehtml" command 2021-02-04 11:55:02 -08:00
README.md Update links in documentation. (#5689) 2019-11-08 09:15:01 +00:00
requirements.txt
robots.txt Reinstate spidering of other documentation versions besides stable 2021-02-02 15:15:43 +00:00
spelling_wordlist.txt Add more names and jargon to spelling wordlist 2020-10-03 14:43:03 +01:00
support.rst Add documentation for reporting security issues 2020-04-20 11:57:26 +10:00

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.