From bcd7033b61c42120e29ac696e4c1c7df36974a10 Mon Sep 17 00:00:00 2001 From: Anusha Ramineni Date: Mon, 30 Jan 2017 17:05:24 +0530 Subject: [PATCH] Fix modindex link Currently, module index is not generated, this patch enables the link modindex link present here https://github.com/openstack/valence/blob/master/doc/source/index.rst Change-Id: Ifa2eee4611afdfd14bc0af5e53716e1e881516f9 --- doc/source/conf.py | 3 +++ setup.cfg | 6 +++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 1058e9c..c6d68bd 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -58,6 +58,9 @@ pygments_style = 'sphinx' # html_theme = '_theme' # html_static_path = ['static'] +# A list of ignored prefixes for module index sorting. +modindex_common_prefix = ['valence.'] + # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/setup.cfg b/setup.cfg index 71f6ac3..008092b 100644 --- a/setup.cfg +++ b/setup.cfg @@ -23,6 +23,10 @@ classifier = packages = valence +[pbr] +autodoc_index_modules = True +warnerrors = True + [build_sphinx] source-dir = doc/source build-dir = doc/build @@ -53,4 +57,4 @@ source-dir = releasenotes/source [entry_points] console_scripts = valence = valence.cmd.api:main - db_manager = valence.cmd.db_manager:main \ No newline at end of file + db_manager = valence.cmd.db_manager:main