0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
2021-03-23 18:57:53 +00:00
..
_static Fix the DocSearch search input appearing smaller after initialization (#6883) 2021-03-08 13:35:21 +00:00
_templates Fix DocSearch widget initialisation JS error (#6884) 2021-03-08 14:18:01 +00:00
advanced_topics Extend explanation of StructValue 2021-03-23 18:57:53 +00:00
contributing Change master to main (#6830) 2021-03-03 13:33:19 -05: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 Create a 'streamfield' subsection within the reference docs 2021-03-23 18:57:53 +00:00
releases Fix references to block classes in release notes 2021-03-23 18:57:53 +00:00
topics Create a 'streamfield' subsection within the reference docs 2021-03-23 18:57:53 +00:00
autobuild.sh
conf.py Switch documentation search to Algolia DocSearch (#6833) 2021-03-08 11:51:06 +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 Change master to main (#6830) 2021-03-03 13:33:19 -05: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

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.