wagtail/docs
jacobtoppm 9b659cb187 Disable webpack css url rewriting (#8518)
This was causing relative urls to be rewritten to use the publicPath.
This meant that the icon font would be referenced at the wrong location
if sites had changed STATIC_URL
fixes #8517
2022-05-11 19:28:57 +10:00
..
_static Pin sphinx-wagtail-theme==5.1.0 2022-04-07 18:53:52 +01:00
_templates
advanced_topics Add guidance on rendition prefetching to docs (#8363) 2022-04-16 10:18:42 +00:00
contributing Add Wagtail 3 classifier to documentation 2022-05-08 19:28:29 +10:00
editor_manual
extending Make nested list render as a nested list (#8516) 2022-05-11 09:05:59 +01:00
getting_started
reference API docs for Panel 2022-04-22 17:28:28 +01:00
releases Disable webpack css url rewriting (#8518) 2022-05-11 19:28:57 +10:00
topics Add use_json_field=True to all StreamField examples (#8359) 2022-04-14 11:09:19 +01:00
Makefile
README.md
autobuild.sh
conf.py Pin sphinx-wagtail-theme==5.1.0 2022-04-07 18:53:52 +01:00
favicon.ico
index.rst
logo.png
requirements.txt Pin sphinx-wagtail-theme==5.1.1 2022-04-08 09:10:22 +10:00
robots.txt
spelling_wordlist.txt
support.rst

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.