Generate API documentation in the _api folder
This commit is contained in:
parent
34d1e5e67e
commit
385328ffd5
3
.gitignore
vendored
3
.gitignore
vendored
|
@ -10,5 +10,4 @@ settings.py
|
|||
.idea/*
|
||||
.cache/*
|
||||
docs/_build/
|
||||
docs/sanic.rst
|
||||
docs/modules.rst
|
||||
docs/_api/
|
||||
|
|
|
@ -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:
|
||||
|
||||
```bash
|
||||
rm -f docs/sanic.rst
|
||||
rm -f docs/modules.rst
|
||||
sphinx-apidoc -o docs/ sanic
|
||||
rm -f docs/_api/*
|
||||
sphinx-apidoc -o docs/_api/ sanic
|
||||
sphinx-build -b html docs docs/_build
|
||||
```
|
||||
|
||||
|
|
|
@ -25,7 +25,7 @@ Module Documentation
|
|||
|
||||
.. toctree::
|
||||
|
||||
Module Reference <sanic>
|
||||
Module Reference <_api/sanic>
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`search`
|
||||
|
|
Loading…
Reference in New Issue
Block a user