Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems * Adds version to PDF files Update Sphinx version as well. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. Add Pygments to fix pep8 failure. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I964ac70a4ab0b1ff92876e85e3bca21e089480b3
This commit is contained in:
parent
7408e1dc50
commit
4caa45d00f
12
README.rst
12
README.rst
|
@ -32,15 +32,21 @@ Getting Started
|
||||||
.. note:: This is an OpenStack Client plugin. The ``python-openstackclient``
|
.. note:: This is an OpenStack Client plugin. The ``python-openstackclient``
|
||||||
project should be installed to use this plugin.
|
project should be installed to use this plugin.
|
||||||
|
|
||||||
Octavia client can be installed from PyPI using pip::
|
Octavia client can be installed from PyPI using pip
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
pip install python-octaviaclient
|
pip install python-octaviaclient
|
||||||
|
|
||||||
If you want to make changes to the Octavia client for testing and contribution,
|
If you want to make changes to the Octavia client for testing and contribution,
|
||||||
make any changes and then run::
|
make any changes and then run
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
python setup.py develop
|
python setup.py develop
|
||||||
|
|
||||||
or::
|
or
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
pip install -e .
|
pip install -e .
|
||||||
|
|
|
@ -2,11 +2,11 @@
|
||||||
# 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.
|
||||||
|
|
||||||
sphinx>=1.6.2,!=1.6.6,!=1.6.7,!=2.1.0 # BSD
|
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||||
openstackdocstheme>=1.20.0 # Apache-2.0
|
openstackdocstheme>=2.2.1 # Apache-2.0
|
||||||
|
|
||||||
# releasenotes
|
# releasenotes
|
||||||
reno>=2.5.0 # Apache-2.0
|
reno>=3.1.0 # Apache-2.0
|
||||||
|
|
||||||
# PDF Docs
|
# PDF Docs
|
||||||
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
|
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
|
||||||
|
|
|
@ -41,16 +41,6 @@ master_doc = 'index'
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
copyright = u'2016-2019, OpenStack Foundation'
|
copyright = u'2016-2019, OpenStack Foundation'
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
|
||||||
# |version| and |release|, also used in various other places throughout the
|
|
||||||
# built documents.
|
|
||||||
#
|
|
||||||
# Version info
|
|
||||||
from octaviaclient.version import version_info as octavia_client_version
|
|
||||||
release = octavia_client_version.release_string()
|
|
||||||
# The short X.Y version.
|
|
||||||
version = octavia_client_version.version_string()
|
|
||||||
|
|
||||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||||
add_function_parentheses = True
|
add_function_parentheses = True
|
||||||
|
|
||||||
|
@ -59,12 +49,12 @@ 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'
|
||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
repository_name = 'openstack/python-octaviaclient'
|
openstackdocs_repo_name = 'openstack/python-octaviaclient'
|
||||||
bug_project = '911'
|
openstackdocs_pdf_link = True
|
||||||
bug_tag = 'doc'
|
openstackdocs_use_storyboard = True
|
||||||
|
|
||||||
autoprogram_cliff_application = 'openstack'
|
autoprogram_cliff_application = 'openstack'
|
||||||
|
|
||||||
|
|
|
@ -36,6 +36,7 @@ pep8==1.5.7
|
||||||
positional==1.2.1
|
positional==1.2.1
|
||||||
pycparser==2.18
|
pycparser==2.18
|
||||||
pyflakes==0.8.1
|
pyflakes==0.8.1
|
||||||
|
Pygments==2.2.0
|
||||||
pylint==1.9.2
|
pylint==1.9.2
|
||||||
pyOpenSSL==17.1.0
|
pyOpenSSL==17.1.0
|
||||||
pyperclip==1.5.27
|
pyperclip==1.5.27
|
||||||
|
|
|
@ -43,9 +43,8 @@ extensions = [
|
||||||
]
|
]
|
||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
repository_name = 'openstack/python-octaviaclient'
|
openstackdocs_repo_name = 'openstack/python-octaviaclient'
|
||||||
bug_project = '911'
|
openstackdocs_use_storyboard = True
|
||||||
bug_tag = 'doc'
|
|
||||||
|
|
||||||
# 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']
|
||||||
|
@ -92,7 +91,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 = []
|
||||||
|
|
|
@ -6,6 +6,7 @@ hacking>=3.0,<3.1.0 # Apache-2.0
|
||||||
requests-mock>=1.2.0 # Apache-2.0
|
requests-mock>=1.2.0 # Apache-2.0
|
||||||
coverage!=4.4,>=4.0 # Apache-2.0
|
coverage!=4.4,>=4.0 # Apache-2.0
|
||||||
doc8>=0.6.0 # Apache-2.0
|
doc8>=0.6.0 # Apache-2.0
|
||||||
|
Pygments>=2.2.0 # BSD license
|
||||||
bandit!=1.6.0,>=1.1.0 # Apache-2.0
|
bandit!=1.6.0,>=1.1.0 # Apache-2.0
|
||||||
flake8-import-order==0.12 # LGPLv3
|
flake8-import-order==0.12 # LGPLv3
|
||||||
pylint>=2.2.0 # GPLv2
|
pylint>=2.2.0 # GPLv2
|
||||||
|
|
Loading…
Reference in New Issue