Our CLI docs are very out of date. These used to be generated by the
docs team with some tooling they had. Since the docs moved in-repo, that
tooling has gone away, and for the most part no one has done any updates
to the CLI docs.
This adds a sphinx directive that will generate these docs every time
the docs are built. This way, whenever someone makes a CLI change, they
do not need to have to know to also edit a documentation file to match
their change. Any code changes will automatically be picked up and
reflected in the docs.
Change-Id: I4406872ab6e9335e338b710e492171580df74fa5
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
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
Update Sphinx version as well.
openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.
Set openstackdocs_auto_name to use project as name.
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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I2cc022495b162bec1424ec69611acb879900c005
This needs to go to "python-cinderclient"
to work instead of "cinderclient".
Add a "doc" tag to these bugs as well.
Change-Id: I45ae03e9c071dd9b159b1c0183b53db4dd837453
The previously choosen PDF file name conflicts in some repos with the
project logos (badge). Thus change https://review.opendev.org/679777
renames the desired PDF name to be doc-PROJECT.pdf to allow using the
badge in PDF files.
Follow this rename.
Change-Id: Ife8461f00ba2206d18ae45837bbc31d211e29841
This patch updates tox.ini to build the pdf version of
cinderclient documentation.
run tox -epdf-docs
Change-Id: If1f43e593db6ff6740b8a88b517c4505e39a3edd
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: Icbfa21da1e83f745a98822a2f33c4ebc8d11fd0c
Doc build keeps failing w/
Recursion error:
maximum recursion depth exceeded while pickling an object
Sphinx recommends bumping up the recursion limit to
get around this, and it appears to work.
Change-Id: If0a78f9af2e4ddd5fd88c44757642355b3a5bf2e
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate the
setting from the old warnerrors one.
Change-Id: Ifd411ead74497a43ab22c57090ece2e1c7cfddb5
Ia3b5ee2b6aaf17781d3de7546a9477f1c928092f moved cinder.rst from the
doc/source/man directory into doc/source/cli, so we need to adjust
the path in conf.py to avoid issues when running:
python setup.py build_sphinx -b man
Change-Id: I32ca20e0e184b11c68c9b81a9ff3d1247330ade4
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.
[0]https://review.openstack.org/#/c/472275/
Change-Id: Ie5930c73c748bb308940606fced8f84eecdecdc8
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)
This also removes the requirement for internet access during docs build.
This can cause docs jobs to fail if the project errors out on
warnings.
Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
The current developer docs theme used is out of sync with the other
openstack projects. This patch will update the docs to provide a more
consistent look and feel when using developer docs
Change-Id: I9fd11b61d4404ba2627569074dc86ee0ddf0f96a
Provide basic but hopefully useful man page.
shell.rst was merged into and replaced by the man page in HTML docs.
pbr is used to determine version.
Docs copyright was changed to more accurate "OpenStack Contributors".
Fixes: bug 1206968
Implements: blueprint clients-man-pages
Change-Id: Iedd7b4b161ced564833fd9433762b87a4c1a374d
Python3 enforces the distinction between byte
strings and text strings more rigorously than
python2. So use six.text_type where approiate.
Change-Id: I46b3f5fe1f990fc1b7a3ee32904d608b070fc4c3
Signed-off-by: Chuck Short <chuck.short@canonical.com>
To better facilitate the building and publishing of sphinx
documentation by Jenkins we are moving all openstack projects with
sphinx documentation to a common doc tree structure. Documentation
goes in project/doc and build results go in project/doc/build.
Change-Id: I3ae14ac735d9b4c0b534eac9a9c142f8ccaac1b9
