wagtail/docs/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.
Better docs docs Link to online rst editor. 2014-03-11 12:01:00 +01:00			`# Wagtail docs`

Update docs links to reference new domain 2022-01-11 16:36:14 +01:00			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):
Docs docs How to author and build Wagtail docs 2014-03-11 11:10:04 +01:00
Eliminate reference to requirements-dev.txt 2016-02-05 16:48:01 +01:00			`pip install -e .[testing,docs]`
Docs docs How to author and build Wagtail docs 2014-03-11 11:10:04 +01:00
Update docs links to reference new domain 2022-01-11 16:36:14 +01:00			`To build the documentation for browsing, from this directory run:`
Docs docs How to author and build Wagtail docs 2014-03-11 11:10:04 +01:00
Update docs links to reference new domain 2022-01-11 16:36:14 +01:00			`make html`
Docs docs How to author and build Wagtail docs 2014-03-11 11:10:04 +01:00
auto-format core markdown files (#8603) - clean up formatting on existing martkdown files to align with prettier 2022-06-01 15:08:56 +02:00			then open `_build/html/index.html` in a browser.
auto doc builder notes 2014-03-11 18:39:08 +01:00
moved pages, images, snippets, form builder, search into reference. Updated requirements, removed conflicting theme css file, updated README 2015-05-14 12:18:53 +02:00			`To rebuild automatically while editing the documentation, from this directory run:`

Removed backticks from readme Forgot to remove backticks from sphinx 2015-10-23 22:04:56 +02:00			`sphinx-autobuild . _build`
Better docs docs Link to online rst editor. 2014-03-11 12:01:00 +01:00
			`The online editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.`