Browse Source

Switch to openstackdocstheme

1. What is the problem
OpenStack doc team is doing OpenStack manuals project migraion, we
need to finish some required actions.

2. What is the solution for the problem
As described in the specification[1], we need switch to use html
theme openstackdocstheme instead of oslosphinx.

3. What features need to be implemented to the Tricircle to
realize the solution
N/A

[1] http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: I678ab6d7682ba016c9e77434693658c25c5d9778
Depends-On: I27481d9d28875837c0bbb4aec89c42aa07027135
changes/84/480384/1
zhiyuan_cai 4 years ago
parent
commit
67816fa139
3 changed files with 18 additions and 5 deletions
  1. +9
    -1
      doc/source/conf.py
  2. +8
    -3
      releasenotes/source/conf.py
  3. +1
    -1
      test-requirements.txt

+ 9
- 1
doc/source/conf.py View File

@ -22,9 +22,14 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [
'sphinx.ext.autodoc',
# 'sphinx.ext.intersphinx',
'oslosphinx'
'openstackdocstheme'
]
# openstackdocstheme options
repository_name = 'openstack/tricircle'
bug_project = 'tricircle'
bug_tag = ''
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable
@ -56,6 +61,9 @@ pygments_style = 'sphinx'
# html_theme_path = ["."]
# html_theme = '_theme'
# html_static_path = ['static']
html_theme = 'openstackdocs'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project


+ 8
- 3
releasenotes/source/conf.py View File

@ -37,10 +37,15 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'oslosphinx',
'openstackdocstheme',
'reno.sphinxext',
]
# openstackdocstheme options
repository_name = 'openstack/tricircle'
bug_project = 'tricircle'
bug_tag = ''
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -110,7 +115,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
@ -148,7 +153,7 @@ 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'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.


+ 1
- 1
test-requirements.txt View File

@ -10,7 +10,7 @@ python-subunit>=0.0.18 # Apache-2.0/BSD
requests-mock>=1.1 # Apache-2.0
docutils>=0.11 # OSI-Approved Open Source, Public Domain
sphinx!=1.6.1,>=1.5.1 # BSD
oslosphinx>=4.7.0 # Apache-2.0
openstackdocstheme>=1.11.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD
testtools>=1.4.0 # MIT
testresources>=0.2.4 # Apache-2.0/BSD


Loading…
Cancel
Save