0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
Matt Westcott a28376a5c9 Give 404 pages a meaningful HTML title in project template (#7262)
Improve the generation of `<title>` tags as follows:

* use `page` in preference to `self` (self has been semi-deprecated ever since we added jinja2 support)
* Retrieve current site with `{% wagtail_site %}` rather than page.get_site so that it works on non-pages such as 404s
* Fill in the 'title' block on 404.html
2021-06-21 14:53:08 +01:00
..
_static Prevent “Forgotten password” link from overlapping with field on mobile devices (#6748) 2021-05-14 22:26:44 +01:00
_templates Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
advanced_topics docs: update custom_account_settings.rst 2021-06-16 10:19:03 +01:00
contributing Update JavaScript guidelines to say two space indent 2021-05-17 15:26:10 +01:00
editor_manual Add documentation for commenting 2021-04-30 17:46:08 +01:00
getting_started Drop support for Django 2.2 2021-04-30 10:33:41 +01:00
reference Add titlesonly to reference / topics top-level TOCs 2021-06-18 15:17:24 +01:00
releases Give 404 pages a meaningful HTML title in project template (#7262) 2021-06-21 14:53:08 +01:00
topics Add titlesonly to reference / topics top-level TOCs 2021-06-18 15:17:24 +01:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02:00
favicon.ico add favicon to documentation 2018-03-08 12:24:13 +00:00
index.rst Replace Divio with Gitpod 2021-04-20 17:19:33 +01:00
logo.png reduced size of logo 2015-07-07 14:41:41 +01:00
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 Add Sphinx Wagtail Theme (#6930) 2021-04-20 11:24:17 +02: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.