diff options
author | Andreas Jaeger <aj@suse.com> | 2020-02-22 17:42:31 +0100 |
---|---|---|
committer | Andreas Jaeger <aj@suse.com> | 2020-02-22 19:11:19 +0100 |
commit | cc1ccae62961b80358c740662bf482e047f78e67 (patch) | |
tree | 6f6688f0d8e4ff11b254647b5393a66429056cfe /api-ref/source | |
parent | 2d301d0a21863c6c0fbb9e854c7eb8ad8f19bbc1 (diff) | |
download | trove-cc1ccae62961b80358c740662bf482e047f78e67.tar.gz |
Cleanup docs building
Remove build_sphinx from setup.cfg, it's not used anymore since this
repo uses sphinx-build directly.
Require newer openstackdocstheme version and remove settings in conf.py
that are now default.
Remove doc/source/install/conf.py, it is not used anymore.
Change-Id: Id89c664384c3ad443d701f5d4135a9f3f9f744d7
Diffstat (limited to 'api-ref/source')
-rwxr-xr-x | api-ref/source/conf.py | 48 |
1 files changed, 4 insertions, 44 deletions
diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 11ae6892..665c9044 100755 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -25,21 +25,20 @@ # serve to show the default. import os -import subprocess import sys -import warnings - -import openstackdocstheme extensions = [ 'os_api_ref', + 'openstackdocstheme' ] html_theme = 'openstackdocs' -html_theme_path = [openstackdocstheme.get_html_theme_path()] html_theme_options = { "sidebar_mode": "toc", } +repository_name = 'openstack/trove' +bug_project = 'trove' +bug_tag = '' # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -67,25 +66,6 @@ master_doc = 'index' project = u'Database API Reference' copyright = u'2010-present, OpenStack Foundation' -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -from trove.version import version_info -# The full version, including alpha/beta/rc tags. -release = version_info.release_string() -# The short X.Y version. -version = version_info.version_string() - -# Config logABug feature -giturl = ( - u'https://opendev.org/openstack/trove/src/branch/master/api-ref/source') -# source tree -# html_context allows us to pass arbitrary values into the html template -html_context = {"bug_tag": "api-ref", - "giturl": giturl, - "bug_project": "trove"} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # @@ -115,15 +95,6 @@ show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' -# Config logABug feature -# source tree -giturl = ( - u'https://opendev.org/openstack/trove/src/branch/master/api-ref/source') -# html_context allows us to pass arbitrary values into the html template -html_context = {'bug_tag': 'api-ref', - 'giturl': giturl, - 'bug_project': 'trove'} - # -- Options for man page output ---------------------------------------------- # Grouping the document tree for man pages. @@ -166,17 +137,6 @@ html_context = {'bug_tag': 'api-ref', # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = ['_static'] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' -git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", - "-n1"] -try: - html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8') -except Exception: - warnings.warn('Cannot get last updated time from git repository. ' - 'Not setting "html_last_updated_fmt".') - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True |