0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
Tibor Leupold aefff4e56c
Docs: Convert "reporting security issues" from RST to MD (#6829)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2021-02-23 10:26:12 +00:00
..
_static Add documentation formatting reference (#6729) 2021-01-29 10:38:47 +00:00
_templates Insert Plausible.io analytics code into docs 2021-02-18 18:14:10 +00:00
advanced_topics Remove jinja2 from advanced_topics index 2021-02-04 20:34:20 +00:00
contributing Docs: Convert "reporting security issues" from RST to MD (#6829) 2021-02-23 10:26:12 +00:00
editor_manual Promote panel changes 2021-02-11 07:50:04 -07:00
getting_started Add explanations to tutorial (#6797) 2021-02-05 14:45:51 -05:00
reference moved jinja2 page from Advanced Topics to Reference 2021-02-04 12:12:11 -08:00
releases Release note for #6822 in 2.12.2 2021-02-18 09:21:38 +00:00
topics Changed heading in image index (#6773) 2021-02-04 15:59:36 +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
requirements.txt
robots.txt Reinstate spidering of other documentation versions besides stable 2021-02-02 15:15:43 +00:00
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.