wagtail/docs
LB Johnston 955ca7ad50 update Sphinx Wagtail Theme to 5.3.0
* https://pypi.org/project/sphinx-wagtail-theme/5.3.0/
* https://github.com/wagtail/sphinx_wagtail_theme/blob/main/CHANGELOG.md#530---2022-08-20
* https://github.com/wagtail/sphinx_wagtail_theme/blob/main/CHANGELOG.md#520---2022-08-17

Additional changes
- use the magnify icon on the search field like the sphinx theme
- ensure the algolia search inputs work correctly for dark mode (the JS initially grabs the colour on page load and put on the new input field)
- fix issue of overflow x hidden being required due to the hidden input field not wrapping
- remove custom.css overrides that are no longer needed (are in the theme)
2022-08-24 06:07:47 +10:00
..
_static update Sphinx Wagtail Theme to 5.3.0 2022-08-24 06:07:47 +10:00
_templates update Sphinx Wagtail Theme to 5.3.0 2022-08-24 06:07:47 +10:00
advanced_topics fix up legacy release note refs & use consistent format 2022-08-16 12:42:42 +01:00
contributing Fix dead Transifex links 2022-08-19 17:28:31 +10:00
editor_manual fix up legacy release note refs & use consistent format 2022-08-16 12:42:42 +01:00
extending Update admin_views.md 2022-08-22 12:52:04 +10:00
getting_started fix up legacy release note refs & use consistent format 2022-08-16 12:42:42 +01:00
reference Add links to topic guide from mixin reference docs 2022-08-21 07:18:27 +10:00
releases fix formatting issues with modal header 2022-08-22 16:52:16 +10:00
topics Add links to topic guide from mixin reference docs 2022-08-21 07:18:27 +10:00
Makefile Fix broken "make livehtml" command 2021-02-04 11:55:02 -08:00
README.md auto-format core markdown files (#8603) 2022-06-01 23:08:56 +10:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py replace latin abbreviations with english phrases & updated docs guidelines 2022-07-20 16:11:38 +10:00
favicon.ico add favicon to documentation 2018-03-08 12:24:13 +00:00
index.rst Update links to wagtail.io website to point to wagtail.org 2022-01-15 20:23:44 +10:00
logo.png
requirements.txt update Sphinx Wagtail Theme to 5.3.0 2022-08-24 06:07:47 +10:00
robots.txt Update docs links to reference new domain 2022-01-15 20:04:24 +10:00
spelling_wordlist.txt Add more names and jargon to spelling wordlist 2020-10-03 14:43:03 +01:00
support.md documentation - migrate docs/support to markdown 2022-06-28 16:16:09 +10:00

README.md

Wagtail docs

These are Sphinx docs, automatically built at https://docs.wagtail.org 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.