x/cloud-init
Code Issues Proposed changes

Include auto-generated API documentation in Sphinx documentation.

Browse Source 
Change-Id: Ic2f0e4bcb315cc3f94e5077dc209431ee3e80d77
This commit is contained in:
Daniel Watkins 2015-06-05 14:44:59 +01:00
parent 2b4e90d8ed
commit 6f039df741
6 changed files with 20 additions and 0 deletions

2
.gitignore vendored

@ -1,3 +1,5 @@
.tox/ .tox/
cloudinit.egg-info/ cloudinit.egg-info/
*.pyc *.pyc
doc/build
doc/source/api/

7
doc/source/api.rst Normal file

@ -0,0 +1,7 @@
cloud-init Python API Documentation
===================================
.. toctree::
:maxdepth: 2
api/autoindex

1
doc/source/api/README Normal file

@ -0,0 +1 @@
Don't put files in here, it's intended only for auto-generated output!

1
doc/source/conf.py

@ -2,3 +2,4 @@
# This file is part of cloud-init. See LICENCE file for license information. # This file is part of cloud-init. See LICENCE file for license information.
# #
# vi: ts=4 expandtab # vi: ts=4 expandtab
extensions = ['sphinx.ext.autodoc']

6
doc/source/contents.rst

@ -12,4 +12,10 @@ Summary
`Cloud-init`_ is the *defacto* multi-distribution package that handles early initialization of a cloud instance. `Cloud-init`_ is the *defacto* multi-distribution package that handles early initialization of a cloud instance.
.. toctree::
:maxdepth: 2
api
.. _Cloud-init: https://launchpad.net/cloud-init .. _Cloud-init: https://launchpad.net/cloud-init

3
setup.cfg

@ -34,3 +34,6 @@ console_scripts =
[build_sphinx] [build_sphinx]
source-dir = doc/source source-dir = doc/source
build-dir = doc/build build-dir = doc/build
[pbr]
autodoc_index_modules = 1