openstack/python-manilaclient
Code Issues Proposed changes

Merge "Switch to newer openstackdocstheme and reno versions"

Browse Source
This commit is contained in:
Zuul 2020-05-22 21:42:56 +00:00 committed by Gerrit Code Review
commit 9613c7fd26
4 changed files with 13 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -1,7 +1,7 @@
# 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.
openstackdocstheme>=1.32.1 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
reno>=2.5.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
sphinxcontrib-programoutput>=0.11 # BSD sphinxcontrib-programoutput>=0.11 # BSD

13
doc/source/conf.py
View File

@ -16,8 +16,6 @@
import os import os
import sys import sys
import openstackdocstheme
# 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
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
@ -43,7 +41,6 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'python-manilaclient'
copyright = u'Rackspace, based on work by Jacob Kaplan-Moss' copyright = u'Rackspace, based on work by Jacob Kaplan-Moss'
# List of directories, relative to source directory, that shouldn't be searched # List of directories, relative to source directory, that shouldn't be searched
@ -58,19 +55,19 @@ add_function_parentheses = True
add_module_names = True add_module_names = True
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'native'
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'python-manilaclientdoc' htmlhelp_basename = 'python-manilaclientdoc'
html_theme = 'openstackdocs' html_theme = 'openstackdocs'
html_theme_path = [openstackdocstheme.get_html_theme_path()]
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/python-manilaclient' openstackdocs_repo_name = 'openstack/python-manilaclient'
bug_project = 'python-manilaclient' openstackdocs_pdf_link = True
bug_tag = 'docs' openstackdocs_bug_project = 'python-manilaclient'
openstackdocs_bug_tag = 'docs'
# -- Options for LaTeX output ------------------------------------------------- # -- Options for LaTeX output -------------------------------------------------

5
lower-constraints.txt
View File

@ -36,7 +36,6 @@ msgpack-python==0.4.0
munch==2.1.0 munch==2.1.0
netaddr==0.7.18 netaddr==0.7.18
netifaces==0.10.4 netifaces==0.10.4
openstackdocstheme==1.32.1
openstacksdk==0.11.2 openstacksdk==0.11.2
os-client-config==1.28.0 os-client-config==1.28.0
os-service-types==1.2.0 os-service-types==1.2.0
@ -70,16 +69,12 @@ python-openstackclient==3.12.0
python-subunit==1.0.0 python-subunit==1.0.0
pytz==2013.6 pytz==2013.6
PyYAML==3.12 PyYAML==3.12
reno==2.5.0
requests==2.14.2 requests==2.14.2
requestsexceptions==1.2.0 requestsexceptions==1.2.0
rfc3986==0.3.1 rfc3986==0.3.1
simplejson==3.5.1 simplejson==3.5.1
six==1.10.0 six==1.10.0
snowballstemmer==1.2.1 snowballstemmer==1.2.1
Sphinx==1.6.5
sphinxcontrib-websupport==1.0.1
sphinxcontrib-programoutput==0.11
stestr==1.0.0 stestr==1.0.0
stevedore==1.20.0 stevedore==1.20.0
tempest==17.1.0 tempest==17.1.0

19
releasenotes/source/conf.py
View File

@ -30,8 +30,6 @@
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
import openstackdocstheme
# If your documentation needs a minimal Sphinx version, state it here. # If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0' # needs_sphinx = '1.0'
@ -44,10 +42,10 @@ extensions = [
] ]
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/python-manilaclient' openstackdocs_repo_name = 'openstack/python-manilaclient'
bug_project = 'python-manilaclient' openstackdocs_bug_project = 'python-manilaclient'
bug_tag = 'release notes' openstackdocs_bug_tag = 'release notes'
html_last_updated_fmt = '%Y-%m-%d %H:%M' openstackdocs_auto_name = False
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -100,7 +98,7 @@ exclude_patterns = []
# show_authors = False # show_authors = False
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'native'
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
# modindex_common_prefix = [] # modindex_common_prefix = []
@ -120,9 +118,6 @@ html_theme = 'openstackdocs'
# documentation. # documentation.
# html_theme_options = {} # html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [openstackdocstheme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to # The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation". # "<project> v<release> documentation".
# html_title = None # html_title = None
@ -149,10 +144,6 @@ html_static_path = ['_static']
# directly to the root of the documentation. # directly to the root of the documentation.
# html_extra_path = [] # html_extra_path = []
# 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'
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
# html_use_smartypants = True # html_use_smartypants = True