openstack/openstack-helm
Code Issues Proposed changes

Update documentation

Browse Source 
Since OSH is an official project and the documentation is published
to docs.o.o, this patch set updates the conf.py to update the theme
to be inline with other openstack projects.

Change-Id: I8e4a8d9e1d2098ef074c3d9503c5c81297f513a7
This commit is contained in:
Tin Lam 2017-11-05 17:18:37 -06:00
parent ed81234e22
commit 470a90f24a
3 changed files with 22 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
doc/source/_static/.placeholder Normal file
View File

28
doc/source/conf.py
View File

@ -20,14 +20,11 @@ sys.path.insert(0, os.path.abspath('../..'))
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [ extensions = [
'sphinx.ext.autodoc' 'sphinx.ext.autodoc',
'openstackdocstheme',
'oslosphinx'
] ]
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if not on_rtd:
extensions.append('oslosphinx')
# autodoc generation is a bit aggressive and a nuisance when doing heavy # autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles. # text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable # execute "export SPHINX_DEBUG=1" in your terminal to disable
@ -49,10 +46,27 @@ add_function_parentheses = True
# unit titles (such as .. function::). # unit titles (such as .. function::).
add_module_names = True add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
show_authors = True
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'sphinx'
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'openstackdocs'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# 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'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# The theme to use for HTML and HTML Help pages. Major themes that come with # The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'. # Sphinx are currently 'default' and 'sphinxdoc'.
@ -74,4 +88,4 @@ latex_documents = [
] ]
# Example configuration for intersphinx: refer to the Python standard library. # Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None} # intersphinx_mapping = {'http://docs.python.org/': None}

1
test-requirements.txt
View File

@ -1,3 +1,4 @@
sphinx>=1.5.1,!=1.6.1 # BSD sphinx>=1.5.1,!=1.6.1 # BSD
oslosphinx>=4.7.0 # Apache-2.0 oslosphinx>=4.7.0 # Apache-2.0
pbr>=3.0.0 # Apache-2.0 pbr>=3.0.0 # Apache-2.0
openstackdocstheme>=1.16.0 # Apache-2.0