0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
jacobtoppm 7e98db7197 Disable webpack css url rewriting
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:27:49 +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 added full_url field for image rendition field api 2022-04-20 07:08:24 +10:00
contributing Add Wagtail 3 classifier to documentation 2022-05-08 19:27:51 +10:00
editor_manual documentation - migrate editor's guide to markdown from RST 2022-04-06 06:48:43 +10:00
extending Make nested list render as a nested list (#8516) 2022-05-11 09:05:02 +01:00
getting_started Move wagtail.admin.edit_handlers to wagtail.admin.panels 2022-03-25 10:44:25 -04:00
reference API docs for Panel 2022-04-22 17:25:30 +01:00
releases Disable webpack css url rewriting 2022-05-11 19:27:49 +10:00
topics convert various documentation pages to Markdown 2022-04-18 08:16:27 +10:00
autobuild.sh
conf.py Pin sphinx-wagtail-theme==5.1.0 2022-04-07 18:53:52 +01: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 Add more names and jargon to spelling wordlist 2020-10-03 14:43:03 +01:00
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.