openstack/oslo.reports
Code Issues Proposed changes

trivial: Remove cruft from sphinx config file

Browse Source 
Change-Id: I707dd369d5a26e463cf3661b82b7563eb575ce5c
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane 2019-12-17 16:30:15 +00:00
parent d18eb6c44a
commit b33d26efab
1 changed files with 6 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
doc/source/conf.py
View File

@ -12,10 +12,6 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
# -- General configuration ---------------------------------------------------- # -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
@ -23,7 +19,6 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinxcontrib.apidoc', 'sphinxcontrib.apidoc',
#'sphinx.ext.intersphinx',
'openstackdocstheme', 'openstackdocstheme',
'oslo_config.sphinxext', 'oslo_config.sphinxext',
] ]
@ -33,16 +28,6 @@ repository_name = 'openstack/oslo.reports'
bug_project = 'oslo.reports' bug_project = 'oslo.reports'
bug_tag = '' bug_tag = ''
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# 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'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
@ -63,33 +48,16 @@ pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['oslo_reports.'] modindex_common_prefix = ['oslo_reports.']
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with # -- Options for HTML output -------------------------------------------------
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
# html_theme = '_theme'
# html_static_path = ['static']
html_theme = 'openstackdocs' html_theme = 'openstackdocs'
# 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 -------------------------------------- # -- sphinxcontrib.apidoc configuration --------------------------------------
apidoc_module_dir = '../../oslo_reports' apidoc_module_dir = '../../oslo_reports'
apidoc_output_dir = 'reference/api' apidoc_output_dir = 'reference/api'
apidoc_excluded_paths = ['tests'] apidoc_excluded_paths = [
'tests',
]