From 39753378753c228b13a0063aae9575352d0c8953 Mon Sep 17 00:00:00 2001 From: Dmitry Tantsur Date: Tue, 8 Mar 2016 15:07:44 +0100 Subject: [PATCH] Generate API documentation from Python modules Also brings "contributing" section toctree depth to the same level as everywhere. Change-Id: I661a0c7045fe945bfa7bd99589751c4aad63a61c --- .gitignore | 1 + doc/source/index.rst | 10 +++++++++- setup.cfg | 5 +++++ 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 73b013cac..21efccf71 100644 --- a/.gitignore +++ b/.gitignore @@ -40,3 +40,4 @@ ChangeLog # Vagrant .vagrant +doc/source/api/ diff --git a/doc/source/index.rst b/doc/source/index.rst index 79bf990d5..5eb46ae6a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -23,10 +23,18 @@ Developer Guide =============== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 Contributing +Python API +---------- + +.. toctree:: + :maxdepth: 1 + + api/autoindex + Indices and tables ================== diff --git a/setup.cfg b/setup.cfg index e70f31cda..fd2c52370 100644 --- a/setup.cfg +++ b/setup.cfg @@ -80,3 +80,8 @@ source-dir = doc/source [pbr] warnerrors = True +autodoc_index_modules = True +autodoc_exclude_modules = + ironic_inspector.migrations.* + ironic_inspector.test.* + ironic.common.i18n