mirrors/wagtail
mirrors/wagtail
0
0
Fork 0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-21 18:09:02 +01:00
Code Issues Releases Wiki Activity
18,189 Commits 56 Branches 258 Tags 589 MiB
main
Commit Graph

13 Commits

Author SHA1 Message Date
Matt Westcott
f7fa20e600 Upgrade Sphinx to 7.3; use newer syntax for no-index directive and --fail-on-warning switch 2024-07-23 10:13:03 +01:00
Matt Westcott
f82f6fd2b7 Downgrade minimum version of Sphinx for Python 3.8 compatibility 
In 5a8c33f34a the minimum version was set to 7.3 to allow use of the long-form `--fail-on-warning` option, but this is not compatible with Python 3.8. Revert this to the original `-W` option and set 7.0 as the minimum version.
 2024-07-19 12:01:18 +01:00
Nathanaël Jourdane
5a8c33f34a doc: fix pdf export (#12076) 2024-07-19 01:27:07 +01:00
Sage Abdullah
6012e4e9d2 Add --jobs auto to build docs in parallel 2024-03-05 07:47:11 +10:00
Sage Abdullah
8cf301ee5d Fix 'make livehtml' command for building docs 2024-03-05 07:47:11 +10:00
Neeraj P Yetheendran
adfd8b32dc Flags added to convert doc build warnings to errors 
- To ensure that the CI will fail if there are broken links or images.
- Fixes #9778
 2024-01-24 10:42:51 +10:00
Andy Chosak
fdf1597263 Fix broken "make livehtml" command 
The documentation suggests running `make livehtml` to automatically
build the docs as you're working on them [0].

This uses the sphinx-autobuild package [1] but unfortunately seems to
have been broken since its most recent release last year [2].

Specifically, the sphinx-autobuild command line syntax no longer accepts
shorthand options -p and -H, requiring use of --port and --host instead.
Additionally the --poll option is no longer supported.

To test, run `cd docs && make livehtml`.

[0] https://docs.wagtail.io/en/stable/contributing/developing.html#compiling-the-documentation
[1] https://github.com/executablebooks/sphinx-autobuild
[2] https://github.com/executablebooks/sphinx-autobuild/blob/master/NEWS.rst#20200901---2020-09-01
 2021-02-04 11:55:02 -08:00
Matt Westcott
878f2784cb Add config section for doc8 in setup.cfg and ignore _build dir 2020-10-21 12:39:32 +01:00
Karl Hobley
9195131738 Lint docs with doc8 2020-10-03 14:43:03 +01:00
Martey Dodoo
229103ff2e Update links in documentation. (#5689) 
Use HTTPS links instead of non-secure HTTP links wherever possible in
documentation.
 2019-11-08 09:15:01 +00:00
Daniel Chimeno
f70226c845 add way of autocompile documentation 2017-02-20 20:24:17 +00:00
Karl Hobley
27facef89e Added spellcheker 2015-04-17 22:49:16 +01:00
Tom Dyson
3b691bc758 First pass at Sphinx docs 2014-02-18 17:45:31 +00:00