Vasanko/sanic
2
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Generate API documentation in the _api folder

Browse Source
This commit is contained in:
Cadel Watson 2017-01-10 09:41:00 +11:00
parent 34d1e5e67e
commit 385328ffd5
3 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -10,5 +10,4 @@ settings.py
.idea/* .idea/*
.cache/* .cache/*
docs/_build/ docs/_build/
docs/sanic.rst docs/_api/
docs/modules.rst

5
docs/contributing.md
View File

@ -13,9 +13,8 @@ Sanic's documentation is built using [sphinx](http://www.sphinx-doc.org/en/1.5.1
To generate the documentation from scratch: To generate the documentation from scratch:
```bash ```bash
rm -f docs/sanic.rst rm -f docs/_api/*
rm -f docs/modules.rst sphinx-apidoc -o docs/_api/ sanic
sphinx-apidoc -o docs/ sanic
sphinx-build -b html docs docs/_build sphinx-build -b html docs docs/_build
``` ```

2
docs/index.rst
View File

@ -25,7 +25,7 @@ Module Documentation
.. toctree:: .. toctree::
Module Reference <sanic> Module Reference <_api/sanic>
* :ref:`genindex` * :ref:`genindex`
* :ref:`search` * :ref:`search`