mirror of
https://github.com/wagtail/wagtail.git
synced 2024-11-22 02:18:39 +01:00
aa9e9cddc7
- Optimized/Customized/Catregorize -> Optimised/Customised/Categorise - Github -> GitHub (80% were spelt with capital H, this is the way GitHub spells itself) - GitPod -> Gitpod (most were without the capital P, Gitpod's site does not use capital P) - Remove duplicate words (to to, the the) - De-coupled -> decoupled - implementors -> implementers (all other references used 'site implementers' so just aligning with the common case) - Fix a/an usage in one case - Fix one comment usage of ok, replace with OK
18 lines
844 B
Markdown
18 lines
844 B
Markdown
# Wagtail docs
|
|
|
|
These are Sphinx docs, automatically built at [https://docs.wagtail.org](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 [MyST playground at Curvenote](https://curvenote.com/blog/working-locally-with-myst-markdown#cFcGTrnCiH) or the [MyST-Markdown VS Code Extension](https://marketplace.visualstudio.com/items?itemName=ExecutableBookProject.myst-highlight) are helpful tools for working with the MyST syntax.
|