From 8c6c3db70b6c4594d17d3b1f5ea7e859d625c489 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Tue, 17 Dec 2019 16:39:20 +0000 Subject: [PATCH] trivial: Cleanup Sphinx config file, setup.cfg Remove unused noise from the former and unused Sphinx configuration from the latter. Change-Id: I754f02fd6eb3c1d77ff2580d53685f4a70da8cc6 Signed-off-by: Stephen Finucane --- doc/source/conf.py | 32 +++++--------------------------- 1 file changed, 5 insertions(+), 27 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 8e0d520..5ef39ad 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -12,10 +12,6 @@ # See the License for the specific language governing permissions and # limitations under the License. -import os -import sys - -sys.path.insert(0, os.path.abspath('../..')) # -- General configuration ---------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be @@ -23,8 +19,7 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', 'sphinxcontrib.apidoc', - #'sphinx.ext.intersphinx', - 'openstackdocstheme' + 'openstackdocstheme', ] # openstackdocstheme options @@ -32,10 +27,6 @@ repository_name = 'openstack/oslo.privsep' bug_project = 'oslo.privsep' bug_tag = '' -# autodoc generation is a bit aggressive and a nuisance when doing heavy -# text edit cycles. -# execute "export SPHINX_DEBUG=1" in your terminal to disable - # The suffix of source filenames. source_suffix = '.rst' @@ -60,26 +51,13 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. -# html_theme_path = ["."] html_theme = 'openstackdocs' -# html_static_path = ['static'] -# Output file base name for HTML help builder. -htmlhelp_basename = '%sdoc' % project - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass -# [howto/manual]). -latex_documents = [ - ('index', - '%s.tex' % project, - u'%s Documentation' % project, - u'OpenStack Foundation', 'manual'), -] - -# Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'http://docs.python.org/': None} # -- sphinxcontrib.apidoc configuration -------------------------------------- + apidoc_module_dir = '../../oslo_privsep' apidoc_output_dir = 'reference/api' +apidoc_excluded_paths = [ + 'tests', +]