0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2021-04-14 15:26:11 +01:00
..
_static Update StreamField Screenshot in Editor's Guide 2021-03-29 16:52:54 +01:00
_templates Fix DocSearch widget initialisation JS error (#6884) 2021-03-08 14:18:01 +00:00
advanced_topics Add contrib simple translation (#6528) 2021-04-14 08:56:00 +01:00
contributing Update links to Diátaxis framework 2021-04-12 14:34:04 +01:00
editor_manual Duplicate block - editor docs 2021-03-17 23:32:57 +00:00
getting_started Docs: Convert "getting started - tutorial" from RST to MD 2021-03-04 10:32:44 +00:00
reference Add contrib simple translation (#6528) 2021-04-14 08:56:00 +01:00
releases Use resolve_url() instead of reverse() for pageurl fallbacks (#7002) 2021-04-14 15:26:11 +01:00
topics Use resolve_url() instead of reverse() for pageurl fallbacks (#7002) 2021-04-14 15:26:11 +01:00
autobuild.sh
conf.py Switch documentation search to Algolia DocSearch (#6833) 2021-03-08 11:51:06 +00:00
favicon.ico add favicon to documentation 2018-03-08 12:24:13 +00:00
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 Change master to main (#6830) 2021-03-03 13:33:19 -05:00
requirements.txt Pin docutils to 0.16 2021-04-06 18:32:38 +01:00
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 main 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.