Browse Source

Migration from oslo_sphinx to openstackdocstheme

As a part of docs migration work[0] for pike we need to switch
to openstackdocstheme

Change-Id: Ida9099e0621d172f9f29fd221bfb47b25c265fac
changes/84/479684/6
ritesh.arya 4 years ago
committed by Ritesh
parent
commit
52b24be74c
3 changed files with 18 additions and 7 deletions
  1. +8
    -2
      doc/source/conf.py
  2. +10
    -4
      releasenotes/source/conf.py
  3. +0
    -1
      test-requirements.txt

+ 8
- 2
doc/source/conf.py View File

@ -22,7 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [
'sphinx.ext.autodoc',
# 'sphinx.ext.intersphinx',
'oslosphinx',
'openstackdocstheme',
'reno.sphinxext'
]
@ -66,7 +66,7 @@ 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.
@ -84,3 +84,9 @@ latex_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None}
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/karbor'
bug_project = project.lower()
bug_tag = ''

+ 10
- 4
releasenotes/source/conf.py View File

@ -21,7 +21,7 @@ import pbr.version
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'oslosphinx',
'openstackdocstheme'
'reno.sphinxext',
]
@ -44,6 +44,12 @@ copyright = u'2016, Karbor Developers'
karbor_version = pbr.version.VersionInfo('karbor')
# The short X.Y version.
version = karbor_version.canonical_version_string()
# openstackdocstheme options
repository_name = 'openstack/karbor'
bug_project = project.lower()
bug_tag = ''
# The full version, including alpha/beta/rc tags.
release = karbor_version.version_string_with_vcs()
@ -90,7 +96,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'openstackdocs'
# 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
@ -128,7 +134,7 @@ html_theme = 'default'
# 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'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
@ -251,4 +257,4 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False
# -- Options for Internationalization output ------------------------------
locale_dirs = ['locale/']
locale_dirs = ['locale/']

+ 0
- 1
test-requirements.txt View File

@ -8,7 +8,6 @@ coverage!=4.4,>=4.0 # Apache-2.0
croniter>=0.3.4 # MIT License
python-subunit>=0.0.18 # Apache-2.0/BSD
sphinx>=1.6.2 # BSD
oslosphinx>=4.7.0 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0
taskflow>=2.7.0 # Apache-2.0
testscenarios>=0.4 # Apache-2.0/BSD


Loading…
Cancel
Save