openstack/requirements
Code Issues Proposed changes

Use oslosphinx for doc build

Browse Source 
Since this is now published on
docs.openstack.org/developer/requirements/ , update theme to use
OpenStack branding.

Include the oslosphinx extension, rename base names from DevStack to
requirements.

Change-Id: Icedd2bbce155b4667c6fe205ca61b9f707a1a8b5
This commit is contained in:
Andreas Jaeger 2015-10-05 12:55:36 +02:00 committed by Andreas Jaeger
parent 9751a9da6c
commit cf2374aac2
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/conf.py
View File

@ -26,7 +26,7 @@ import os
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [ ] extensions = ['oslosphinx']
todo_include_todos = True todo_include_todos = True
@ -78,7 +78,7 @@ show_authors = False
pygments_style = 'sphinx' pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['DevStack-doc.'] modindex_common_prefix = ['requirements-doc.']
# -- Options for man page output ---------------------------------------------- # -- Options for man page output ----------------------------------------------
man_pages = [] man_pages = []
@ -87,7 +87,7 @@ man_pages = []
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'nature' # html_theme = 'nature'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the
@ -156,7 +156,7 @@ html_use_index = False
#html_file_suffix = None #html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'DevStack-doc' htmlhelp_basename = 'requirements-doc'
# -- Options for LaTeX output -------------------------------------------------- # -- Options for LaTeX output --------------------------------------------------

1
test-requirements.txt
View File

@ -13,3 +13,4 @@ setuptools>=16.0
# this is required for the docs build jobs # this is required for the docs build jobs
sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2
oslosphinx>=2.5.0 # Apache-2.0