openstack
/
oslo-specs
Code Issues Proposed changes

Switch to openstackdocstheme 

oslosphinx has been unmaintained for multiple cycles and we shouldn't
be using it anymore.

Some minor changes to the specs were necessary because the newer
sphinx introduced some warnings that were making the doc build fail.

Change-Id: I4d053e39a8859854b7f56bcf654071b7d950297b
This commit is contained in:
Ben Nemec 2019-03-29 11:48:18 -05:00
parent cba6fecac6
commit 9b223579c4
5 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/conf.py
View File

@ -33,12 +33,12 @@ sys.path.insert(0, os.path.abspath('../..'))
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [ extensions = [
'sphinx.ext.autodoc', 'openstackdocstheme',
#'sphinx.ext.intersphinx',
'oslosphinx',
'yasfb', 'yasfb',
] ]
repository_name = 'openstack/oslo-specs'
# Feed configuration for yasfb # Feed configuration for yasfb
feed_base_url = 'http://specs.openstack.org/openstack/oslo-specs' feed_base_url = 'http://specs.openstack.org/openstack/oslo-specs'
feed_author = 'OpenStack Oslo Team' feed_author = 'OpenStack Oslo Team'
@ -89,6 +89,7 @@ pygments_style = 'sphinx'
# html_theme_path = ["."] # html_theme_path = ["."]
# html_theme = '_theme' # html_theme = '_theme'
# html_static_path = ['static'] # html_static_path = ['static']
html_theme = 'openstackdocs'
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project htmlhelp_basename = '%sdoc' % project

6
requirements.txt
View File

@ -1,7 +1,7 @@
pbr>=0.6,<1.0 pbr>=0.6,<1.0
oslosphinx openstackdocstheme>=1.20.0
sphinx>=1.1.2,!=1.2.0,<1.3 sphinx!=1.6.6,>=1.6.2
yasfb>=0.5.0 yasfb>=0.8.0
simplejson>=2.2.0 simplejson>=2.2.0
pyOpenSSL>=0.14 # Apache-2.0 pyOpenSSL>=0.14 # Apache-2.0
pyasn1 # BSD pyasn1 # BSD

2
specs/liberty/privsep.rst
View File

@ -349,7 +349,7 @@ Code coverage
............. .............
``coverage.py`` has support for collecting coverage statistics across ``coverage.py`` has support for collecting coverage statistics across
sub-processes[#coverage_subproc]. To do this, the privileged process sub-processes [#coverage_subproc]_. To do this, the privileged process
will need to call ``coverage.process_startup()`` as early as possible will need to call ``coverage.process_startup()`` as early as possible
(eg: from ``main()``), which enables coverage features if the (eg: from ``main()``), which enables coverage features if the
``COVERAGE_PROCESS_START`` environment variable is set. If the ``COVERAGE_PROCESS_START`` environment variable is set. If the

4
specs/mitaka/rabbitmq-pika-driver.rst
View File

@ -256,8 +256,8 @@ pika library
References References
========== ==========
.. [1] https://github.com/dukhlov/oslo.messaging/blob/master/oslo_messaging/_drivers/impl_pika.py #. https://github.com/dukhlov/oslo.messaging/blob/master/oslo_messaging/_drivers/impl_pika.py
.. [2] https://review.openstack.org/#/c/226348/ #. https://review.openstack.org/#/c/226348/
.. note:: .. note::

4
specs/queens/external-pdp.rst
View File

@ -64,9 +64,7 @@ User will be able to choose between:
The switch between those PDP can be configured and done through the modification of policy.json/yaml. The switch between those PDP can be configured and done through the modification of policy.json/yaml.
For each rule, a URL need to be set. For each rule, a URL need to be set.
Thus every components that use Oslo_Policy can benefit from this improvement. For example in Glance Thus every components that use Oslo_Policy can benefit from this improvement. For example in Glance
policy.json file: policy.json file::
.. code-block:: json
{ {
"context_is_admin": "role:admin", "context_is_admin": "role:admin",