0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 17:36:49 +01:00
wagtail/docs
Serafeim Papastefanos 25ed1ba38e Update django-treebeard dependency to 4.5.1 or above (#7985)
The django-treebeard 4.3.x is not compatible with Django 4.x because of the dreaded ugettext alias removal problem. This makes sure that a proper django-treebeard version will be installed.

*IMPORTANT*: Please notice that django treebeard *does not* officially support django 4.x. However from my tests I have concludeded that it works fine after you install the version 4.5.x.
2022-02-18 10:53:27 +00:00
..
_static Remove legacy browser styles 2022-02-15 16:31:57 +00:00
_templates Indent templates with djhtml 2022-02-12 01:15:51 +00:00
advanced_topics Remove old versionadded / versionchanged notes 2022-02-08 19:00:47 +00:00
contributing Add and configure black 2022-02-15 13:06:17 +00:00
editor_manual Added a section to deployment docs about configuring serving of user uploaded files (#7553) 2022-01-21 11:21:53 +00:00
extending Remove redundant noopener from noreferrer rel attributes 2022-02-15 16:31:57 +00:00
getting_started Remove 'db' and 'postgres_search' search backends 2022-02-08 19:00:47 +00:00
reference Remove old versionadded / versionchanged notes 2022-02-08 19:00:47 +00:00
releases Update django-treebeard dependency to 4.5.1 or above (#7985) 2022-02-18 10:53:27 +00:00
topics Updated docs link to supported Django version (#7917) 2022-02-04 12:33:56 +00:00
autobuild.sh
conf.py Reformat with black 2022-02-15 13:06:17 +00: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 Docs: Update sphinx-wagtail-theme to 5.0.4 (#7296) 2021-06-30 11:18:07 +02: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.