Switch to openstackdocstheme

Provides consistency across other specifications
on specs.openstack.org.

Change-Id: Ibcdba4fe820193b1594f36cef6c31c24005bd464
This commit is contained in:
Goutham Pacha Ravi 2018-04-27 13:27:29 -07:00
parent 4d69ce3206
commit d3e3d1b8a9
3 changed files with 12 additions and 4 deletions

View File

@ -28,7 +28,7 @@ extensions = [
'sphinxcontrib.actdiag',
'sphinxcontrib.seqdiag',
'sphinxcontrib.nwdiag',
'oslosphinx',
'openstackdocstheme',
# TODO(tbarron): re-enable yasfb after
# https://github.com/sphinxcontrib/yasfb/commit/62d18c66835320af4a71fb088cb502041478fb16
# is released; it currently breaks with python 3.5
@ -72,12 +72,16 @@ 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 = '_theme'
html_theme = 'openstackdocs'
# html_static_path = ['static']
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
@ -90,3 +94,7 @@ latex_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
# intersphinx_mapping = {'http://docs.python.org/': None}
repository_name = 'openstack/manila-specs'
bug_project = 'manila'
bug_tag = ''

View File

@ -3,7 +3,7 @@ pbr>=2.0.0
actdiag
blockdiag
nwdiag
oslosphinx>=4.7.0
openstackdocstheme>=1.18.1 # Apache-2.0
seqdiag
sphinx>=1.5.1,!=1.6.1 # BSD
sphinxcontrib-actdiag

View File

@ -24,6 +24,6 @@ commands = {posargs}
whitelist_externals = rm
commands =
rm -rf doc/build
python setup.py build_sphinx
sphinx-build -b html doc/source doc/build/html
# Ignore D001 since we allow lines in excess of 79 characters.
doc8 --ignore D001 --ignore-path .tox --ignore-path .eggs --ignore-path doc/build --ignore-path manila_specs.egg-info -e txt -e rst