Hopiu/wagtail
1
0
Fork 0
mirror of https://github.com/Hopiu/wagtail.git synced 2026-04-24 16:44:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Better docs docs

Browse source 
Link to online rst editor.
This commit is contained in:
Tom Dyson 2014-03-11 11:01:00 +00:00
parent b6dddc256e
commit c67c51c5fc
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/README.md
View file

@ -1,4 +1,6 @@
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:
# Wagtail docs
These are Sphinx docs, automatically built at http://docs.wagtail.io when the master branch is committed to Github. To build them locally, install Sphinx and the RTD theme:
pip install Sphinx
pip install sphinx-rtd-theme
@ -13,3 +15,5 @@ To auto-build your local docs when you save:
--ignore-pattern='_build/*' \
--recursive \
--command='make html'
The online editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.