0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
Tibor Leupold 4f5d688021 Add ability for upgrade notification to show the relevant release to the user
This now implements the logic to link to the next minor's release notes
when such a version difference is computed. If a patch release
difference is computed, then those release notes are linked.

The utils.tests.js seemed a bit unexpected location, because there is no
`utils.js` module. Now the module defining the tests and the one
defining the functionality are named similarly, as is common in the rest
of the code base.

- resolves #7336
- resolves #7405
- resolves #3938
- fixes #8537

Fix issue where upgrade notification was not using translated content.
2022-05-26 19:57:46 +10:00
..
_static Pin sphinx-wagtail-theme==5.1.0 2022-04-07 18:53:52 +01:00
_templates Indent templates with djhtml 2022-02-12 01:15:51 +00:00
advanced_topics documentation - migrate api section to markdown 2022-05-25 21:01:38 +10:00
contributing fix up spelling in documentation & docstrings (should be en-GB not en-US) 2022-05-13 08:13:06 +10:00
editor_manual documentation - migrate editor's guide to markdown from RST 2022-04-06 06:48:43 +10:00
extending fix up spelling in documentation & docstrings (should be en-GB not en-US) 2022-05-13 08:13:06 +10:00
getting_started fix up spelling in documentation & docstrings (should be en-GB not en-US) 2022-05-13 08:13:06 +10:00
reference Add ability for upgrade notification to show the relevant release to the user 2022-05-26 19:57:46 +10:00
releases Add ability for upgrade notification to show the relevant release to the user 2022-05-26 19:57:46 +10:00
topics fix up spelling in documentation & docstrings (should be en-GB not en-US) 2022-05-13 08:13:06 +10:00
autobuild.sh
conf.py fix up spelling in documentation & docstrings (should be en-GB not en-US) 2022-05-13 08:13:06 +10:00
favicon.ico
index.rst Update links to wagtail.io website to point to wagtail.org 2022-01-15 20:23:44 +10:00
logo.png
Makefile Fix broken "make livehtml" command 2021-02-04 11:55:02 -08:00
README.md Update docs links to reference new domain 2022-01-15 20:04:24 +10:00
requirements.txt Update myst_parser to v0.17.2 (#8380) 2022-04-17 17:57:30 +01:00
robots.txt Update docs links to reference new domain 2022-01-15 20:04:24 +10:00
spelling_wordlist.txt
support.rst Update email addresses for new .org domain (#7845) 2022-01-28 12:16:24 +00:00

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.