From 385328ffd5e640b063b7b0ae3a1a00eedc79308e Mon Sep 17 00:00:00 2001 From: Cadel Watson Date: Tue, 10 Jan 2017 09:41:00 +1100 Subject: [PATCH] Generate API documentation in the _api folder --- .gitignore | 3 +-- docs/contributing.md | 5 ++--- docs/index.rst | 2 +- 3 files changed, 4 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index 535c6a2f..9050c413 100644 --- a/.gitignore +++ b/.gitignore @@ -10,5 +10,4 @@ settings.py .idea/* .cache/* docs/_build/ -docs/sanic.rst -docs/modules.rst \ No newline at end of file +docs/_api/ diff --git a/docs/contributing.md b/docs/contributing.md index c046bd39..a40654cc 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -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 ``` diff --git a/docs/index.rst b/docs/index.rst index 264ebc93..b28d97f7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,7 +25,7 @@ Module Documentation .. toctree:: - Module Reference + Module Reference <_api/sanic> * :ref:`genindex` * :ref:`search`