mirror of
https://github.com/wagtail/wagtail.git
synced 2024-12-01 11:41:20 +01:00
664b0489fe
* Update references to `master` branch to say `main` * Update external links * Update links in old release notes Use tagged versions of code rather than current code
18 lines
619 B
Markdown
18 lines
619 B
Markdown
# Wagtail docs
|
|
|
|
These are Sphinx docs, automatically built at https://docs.wagtail.io 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.
|