summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorAndreas Jaeger <aj@suse.com>2020-02-23 14:04:29 +0100
committerAndreas Jaeger <aj@suse.com>2020-02-29 15:12:04 +0100
commit5cebea361b3fd6344f8a4ec258e57caafbe173f2 (patch)
treee6083a1abee9dd46f3d6654e736dcf64ffa67ebd /api-ref
parent6ba983b615a75c2be69ced795ecde3681dd8f79c (diff)
downloadironic-5cebea361b3fd6344f8a4ec258e57caafbe173f2.tar.gz
Cleanup docs building
* Remove doc/source/install/conf.py, it's unused. * Remove settings that are provided by openstackdocstheme from conf.py files. Switch to newer openstackdocstheme for this. * Remove unused deps from tox.ini: releasenotes and api-refonly need doc/requirements but not requirements. Change-Id: Iab5ad6cde40c3342770c0112155fe5e1d262d1e8
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/conf.py26
1 files changed, 5 insertions, 21 deletions
diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py
index 1c9af11e9..aea4cf4dd 100644
--- a/api-ref/source/conf.py
+++ b/api-ref/source/conf.py
@@ -25,26 +25,22 @@
# serve to show the default.
import os
-import subprocess
import sys
-import openstackdocstheme
-
-# 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 ironic.version import version_info
-
html_theme = 'openstackdocs'
-html_theme_path = [openstackdocstheme.get_html_theme_path()]
html_theme_options = {
"sidebar_mode": "toc",
}
extensions = [
'os_api_ref',
+ 'openstackdocstheme'
]
+repository_name = 'openstack/ironic'
+use_storyboard = True
+
+
# 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
# documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -71,11 +67,6 @@ master_doc = 'index'
project = u'Ironic API Reference'
copyright = u'OpenStack Foundation'
-# The full version, including alpha/beta/rc tags.
-release = version_info.release_string()
-# The short X.Y version.
-version = version_info.version_string()
-
# html_context allows us to pass arbitrary values into the html template
html_context = {"bug_tag": "api-ref",
"bug_project": "ironic"}
@@ -151,13 +142,6 @@ pygments_style = 'sphinx'
# 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"]
-html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8')
-
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True