Update tox "docs" target to also generate API documentation for the whole libcloud package.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/d2c5ffc7 Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/d2c5ffc7 Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/d2c5ffc7 Branch: refs/heads/trunk Commit: d2c5ffc7419f8f84c848162fe3181041f9ae3812 Parents: ca64417 Author: Tomaz Muraus <to...@apache.org> Authored: Sat Sep 27 20:06:24 2014 +0200 Committer: Tomaz Muraus <to...@apache.org> Committed: Sat Sep 27 20:06:52 2014 +0200 ---------------------------------------------------------------------- .gitignore | 1 + docs/api_docs.rst | 7 +++++++ docs/index.rst | 1 + tox.ini | 3 ++- 4 files changed, 11 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/d2c5ffc7/.gitignore ---------------------------------------------------------------------- diff --git a/.gitignore b/.gitignore index dc61a25..45fbe88 100644 --- a/.gitignore +++ b/.gitignore @@ -13,6 +13,7 @@ coverage_html_report/ .idea dist/*apache-libcloud* dist/*apache_libcloud* +docs/apidocs/* _build/ apache_libcloud.egg-info/ .project http://git-wip-us.apache.org/repos/asf/libcloud/blob/d2c5ffc7/docs/api_docs.rst ---------------------------------------------------------------------- diff --git a/docs/api_docs.rst b/docs/api_docs.rst new file mode 100644 index 0000000..2cb0a0a --- /dev/null +++ b/docs/api_docs.rst @@ -0,0 +1,7 @@ +API Documentation +================= + +For automatically generated API documentation of all the modules, +please visit `this page`_. + +.. _`this page`: apidocs/modules.html http://git-wip-us.apache.org/repos/asf/libcloud/blob/d2c5ffc7/docs/index.rst ---------------------------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index d026329..02e1858 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,6 +37,7 @@ Main loadbalancer/index dns/index troubleshooting + api_docs faq other/* http://git-wip-us.apache.org/repos/asf/libcloud/blob/d2c5ffc7/tox.ini ---------------------------------------------------------------------- diff --git a/tox.ini b/tox.ini index 30516b0..2d06eba 100644 --- a/tox.ini +++ b/tox.ini @@ -50,7 +50,8 @@ deps = sphinx basepython = python2.7 changedir = docs commands = python ../contrib/generate_provider_feature_matrix_table.py - sphinx-build -W -b html -d {envtmpdir}/doctrees . _build/html + sphinx-apidoc -d 2 ../libcloud/ -o apidocs/ + sphinx-build -b html -d {envtmpdir}/doctrees . _build/html [testenv:scrape-ec2-prices] deps = requests
