mirror of
https://github.com/Hopiu/wagtail.git
synced 2026-05-10 16:24:49 +00:00
Docs docs
How to author and build Wagtail docs
This commit is contained in:
parent
7688763aa2
commit
8609361ed4
1 changed files with 15 additions and 0 deletions
15
docs/README.md
Normal file
15
docs/README.md
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
Sphinx docs, automatically built at docs.wagtail.io when the master branch is committed to Github. To build locally, install Sphinx and the RTD theme:
|
||||
|
||||
pip install Sphinx
|
||||
pip install sphinx-rtd-theme
|
||||
|
||||
Then ``make html`` from this directory, and open ``_build/html/index.html`` in your browser.
|
||||
|
||||
To auto-build your local docs when you save:
|
||||
|
||||
pip install watchdog
|
||||
$ watchmedo shell-command \
|
||||
--patterns="*.rst" \
|
||||
--ignore-pattern='_build/*' \
|
||||
--recursive \
|
||||
--command='make html'
|
||||
Loading…
Reference in a new issue