openstack/python-magnumclient
Code Issues Proposed changes

switch to openstackdocstheme

Browse Source 
As part of the docs migration work[0] for Pike we need to switch
to use the openstackdocstheme.

[0]https://review.openstack.org/#/c/472275/

Change-Id: Idb5e5f47f0e8c63d7142a1a43990bf586ff4dbee
This commit is contained in:
Kiran_totad 2017-07-04 15:04:25 +05:30 committed by yatin
parent babbdb7083
commit de67cbb1ac
2 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/conf.py
View File

@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx', #'sphinx.ext.intersphinx',
'oslosphinx', 'openstackdocstheme'
] ]
# autodoc generation is a bit aggressive and a nuisance when doing heavy # autodoc generation is a bit aggressive and a nuisance when doing heavy
@ -58,9 +58,16 @@ modindex_common_prefix = ['magnumclient.']
# 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'.
# html_theme_path = ["."] # html_theme_path = ["."]
# html_theme = '_theme' html_theme = 'openstackdocs'
# html_static_path = ['static'] # html_static_path = ['static']
# openstackdocstheme options
repository_name = 'openstack/python-magnumclient'
bug_project = 'python-magnumclient'
bug_tag = ''
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project htmlhelp_basename = '%sdoc' % project

2
test-requirements.txt
View File

@ -8,7 +8,7 @@ fixtures>=3.0.0 # Apache-2.0/BSD
python-openstackclient!=3.10.0,>=3.3.0 # Apache-2.0 python-openstackclient!=3.10.0,>=3.3.0 # Apache-2.0
python-subunit>=0.0.18 # Apache-2.0/BSD python-subunit>=0.0.18 # Apache-2.0/BSD
sphinx>=1.6.2 # BSD sphinx>=1.6.2 # BSD
oslosphinx>=4.7.0 # Apache-2.0 openstackdocstheme>=1.11.0 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0
osprofiler>=1.4.0 # Apache-2.0 osprofiler>=1.4.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD testrepository>=0.0.18 # Apache-2.0/BSD