Docs cleanup and hacking update

Switch to using sphinx-build, cleanup conf.py, update
to newer sphinx and openstackdocstheme versions for Python 3.

Update to hacking 3.0.

Fix build problems.

Change-Id: Ib3ea77c973a9592710a9d75c76c443881f1a4bc1
This commit is contained in:
Andreas Jaeger 2020-04-17 20:32:41 +02:00
parent 5de857cf1d
commit 795dc20715
7 changed files with 8 additions and 14 deletions

View File

@ -1,2 +1,2 @@
sphinx>=1.6.2 # BSD
openstackdocstheme>=1.11.0 # Apache-2.0
sphinx>=2.0.0 # BSD
openstackdocstheme>=2.0.0 # Apache-2.0

View File

@ -105,9 +105,6 @@ repository_name = 'openstack/python-pankoclient'
bug_project = 'python-pankoclient'
bug_tag = ''
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project

View File

@ -2,7 +2,7 @@ The OSC CLI plugins
===================
This program provides a set of event related commands which are performed by
OSC `openstack program`_. The `OpenStackClient`_ project provide a plugin
OSC `openstack program`_. The `OpenStackClient`_ project provide a plugin
mechanism which supports loading other external projects' commands from
clients library entry points.

View File

@ -51,7 +51,7 @@ class PankoShell(app.App):
version=__version__,
command_manager=PankoCommandManager(None),
deferred_help=True,
)
)
self._client = None

View File

@ -155,11 +155,6 @@ html_static_path = ['_static']
# directly to the root of the documentation.
# html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True

View File

@ -30,7 +30,7 @@ packages =
[extras]
test =
coverage>=4.0 # Apache-2.0
hacking>=0.12.0,!=0.13.0,<0.14 # Apache-2.0
hacking>=3.0,<3.1.0 # Apache-2.0
mock>=2.0 # BSD
python-openstackclient>=3.3.0 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0

View File

@ -30,7 +30,7 @@ commands =
deps = -r{toxinidir}/doc/requirements.txt
commands =
rm -rf doc/source/ref
python setup.py build_sphinx
sphinx-build -W -b html doc/source doc/build/html
[testenv:releasenotes]
commands =
@ -41,5 +41,7 @@ commands = oslo_debug_helper -t pankoclient/tests {posargs}
[flake8]
show-source = True
# W504 line break after binary operator
ignore = W504
builtins = _
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build