Cleanup docs building
* Switch to newer openstackdocstheme version and remove settings that are default now Change-Id: Iec8791077aa7f1cb8edfa64235fb718a98aaba90
This commit is contained in:
parent
8b5ec12818
commit
21f94dea86
@ -23,15 +23,9 @@
|
||||
# serve to show the default.
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
from designate.version import version_info
|
||||
|
||||
import openstackdocstheme
|
||||
|
||||
html_theme = 'openstackdocs'
|
||||
html_theme_path = [openstackdocstheme.get_html_theme_path()]
|
||||
html_theme_options = {
|
||||
"sidebar_mode": "toc",
|
||||
"sidebar_dropdown": "api_ref",
|
||||
@ -39,6 +33,7 @@ html_theme_options = {
|
||||
|
||||
extensions = [
|
||||
'os_api_ref',
|
||||
'openstackdocstheme'
|
||||
]
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
@ -71,14 +66,6 @@ copyright = u'OpenStack Foundation'
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# 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': 'designate'}
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
@ -151,13 +138,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
|
||||
|
@ -1,9 +1,9 @@
|
||||
# The order of packages is significant, because pip processes them in the order
|
||||
# of appearance. Changing the order has an impact on the overall integration
|
||||
# process, which may cause wedges in the gate later.
|
||||
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
|
||||
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
|
||||
sphinxcontrib-httpdomain>=1.3.0 # BSD
|
||||
sphinxcontrib-blockdiag>=1.5.4 # BSD
|
||||
reno>=2.5.0 # Apache-2.0
|
||||
os-api-ref>=1.4.0 # Apache-2.0
|
||||
openstackdocstheme>=1.18.1 # Apache-2.0
|
||||
openstackdocstheme>=1.31.2 # Apache-2.0
|
||||
|
@ -13,6 +13,9 @@
|
||||
|
||||
import sys, os
|
||||
|
||||
# oslo.config needs the following import
|
||||
import designate.conf # noqa
|
||||
|
||||
# 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.
|
||||
@ -43,7 +46,6 @@ extensions = ['sphinx.ext.autodoc',
|
||||
repository_name = 'openstack/designate'
|
||||
bug_project = 'designate'
|
||||
bug_tag = ''
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
config_generator_config_file = '../../etc/designate/designate-config-generator.conf'
|
||||
sample_config_basename = '_static/designate'
|
||||
@ -69,17 +71,6 @@ master_doc = 'index'
|
||||
project = u'designate'
|
||||
copyright = u'2012, Managed I.T.'
|
||||
|
||||
# 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.
|
||||
#
|
||||
# The short X.Y version.
|
||||
import designate.conf # noqa
|
||||
from designate.version import version_info as designate_version
|
||||
version = designate_version.canonical_version_string()
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = designate_version.version_string_with_vcs()
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#language = None
|
||||
|
@ -68,7 +68,7 @@ msgpack==0.5.6
|
||||
munch==2.2.0
|
||||
netaddr==0.7.18
|
||||
netifaces==0.10.6
|
||||
openstackdocstheme==1.20.0
|
||||
openstackdocstheme==1.31.2
|
||||
openstacksdk==0.12.0
|
||||
os-api-ref==1.5.0
|
||||
os-client-config==1.29.0
|
||||
|
@ -45,7 +45,6 @@ extensions = [
|
||||
repository_name = 'openstack/designate'
|
||||
bug_project = 'designate'
|
||||
bug_tag = ''
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
Loading…
Reference in New Issue
Block a user