Change keystone-specs webpage from oslosphinx to openstackdocstheme

Change-Id: Iccdbee3ca64bc9c1ca6195d1725dd61a29ddcb20
Closes-Bug: #1755015
This commit is contained in:
Nguyen Hai 2018-03-12 20:37:58 +09:00
parent 7364e98854
commit 9246e7e3d6
4 changed files with 16 additions and 23 deletions

View File

@ -11,6 +11,7 @@
import datetime import datetime
import subprocess import subprocess
import warnings
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
@ -24,21 +25,17 @@ import subprocess
# 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 = ['sphinx.ext.autodoc', extensions = ['sphinx.ext.autodoc',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'sphinxcontrib.blockdiag', 'sphinxcontrib.blockdiag',
'oslosphinx', 'openstackdocstheme',
'yasfb',
] ]
blockdiag_html_image_format = 'SVG' blockdiag_html_image_format = 'SVG'
blockdiag_fontpath = 'DejaVuSans.ttf' blockdiag_fontpath = 'DejaVuSans.ttf'
# Feed configuration for yasfb
feed_base_url = 'http://specs.openstack.org/openstack/keystone-specs'
feed_author = 'OpenStack Identity Team'
todo_include_todos = True todo_include_todos = True
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
@ -97,7 +94,7 @@ modindex_common_prefix = ['identity-specs.']
# 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 = 'openstackdocs'
# 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

View File

@ -1,8 +1,8 @@
.. identity-specs documentation master file .. identity-specs documentation master file
================================ ===============================
Identity Program Specifications Identity Program Specifications
================================ ===============================
Project Documentation: Project Documentation:
@ -12,7 +12,7 @@ Project Documentation:
Specification Template <specs/template> Specification Template <specs/template>
keystone keystone
======== --------
Queens approved specs: Queens approved specs:
@ -50,7 +50,7 @@ Ideas:
specs/keystone/ideas/* specs/keystone/ideas/*
keystoneauth keystoneauth
============ ------------
keystoneauth approved specs for the Newton release: keystoneauth approved specs for the Newton release:
@ -65,7 +65,7 @@ keystoneauth approved specs for the Newton release:
specs/keystoneauth/newton/* specs/keystoneauth/newton/*
keystoneclient keystoneclient
============== --------------
keystoneclient approved specs for the Newton release: keystoneclient approved specs for the Newton release:
@ -80,7 +80,7 @@ keystoneclient approved specs for the Newton release:
specs/keystoneclient/newton/* specs/keystoneclient/newton/*
keystonemiddleware keystonemiddleware
================== ------------------
keystonemiddleware approved specs for the Newton release: keystonemiddleware approved specs for the Newton release:
@ -102,12 +102,11 @@ Backlog:
specs/keystonemiddleware/backlog/* specs/keystonemiddleware/backlog/*
===========================================
Implemented Identity Program Specifications Implemented Identity Program Specifications
=========================================== ===========================================
keystone keystone
======== --------
Pike approved specs: Pike approved specs:
@ -166,7 +165,7 @@ Juno implemented specs:
specs/keystone/juno/* specs/keystone/juno/*
keystoneauth keystoneauth
============ ------------
- None - None
@ -179,7 +178,7 @@ keystoneauth
specs/keystoneauth/mitaka/* specs/keystoneauth/mitaka/*
keystoneclient keystoneclient
============== --------------
Mitaka implemented specs: Mitaka implemented specs:
@ -198,7 +197,7 @@ Liberty implemented specs:
specs/keystoneclient/liberty/* specs/keystoneclient/liberty/*
keystonemiddleware keystonemiddleware
================== ------------------
Kilo implemented specs: Kilo implemented specs:
@ -216,7 +215,6 @@ Juno implemented specs:
specs/keystonemiddleware/juno/* specs/keystonemiddleware/juno/*
==================
Indices and tables Indices and tables
================== ==================

View File

@ -1,11 +1,10 @@
# The order of packages is significant, because pip processes them in the order # The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration # of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later. # process, which may cause wedges in the gate later.
oslosphinx>=2.2.0.0a2
pbr>=2.0.0 pbr>=2.0.0
sphinx!=1.6.1,>=1.5.1 sphinx!=1.6.1,>=1.5.1
sphinxcontrib-blockdiag sphinxcontrib-blockdiag
openstackdocstheme>=1.17.0 # Apache-2.0
testrepository>=0.0.18 testrepository>=0.0.18
testtools>=0.9.34 testtools>=0.9.34
yasfb>=0.5.1
doc8 doc8

View File

@ -16,5 +16,4 @@ commands =
commands = {posargs} commands = {posargs}
[testenv:docs] [testenv:docs]
basepython=python2.7 commands = sphinx-build -W -b html doc/source doc/build/html
commands = python setup.py build_sphinx