This patch creates initial documentation for OSC, with
general plugin information and a few examples.
New commands, that are implemented, should be then
referenced in doc/source/cli/osc/v2/index.rst
Change-Id: I6fa9fcb3cf41a2992a4b5c7b38c54825106e9ce5
Partially-implements: bp openstack-client-support
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.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
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.
Set openstackdocs_auto_name to use 'project' as name.
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: I1d02403727831c29f3a38cfc11949325614ac7d0
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
know about the requirement
- Remove obsolete sections from setup.cfg: Wheel is not needed for python
3 only repo
- Update requirements, no need for python_version anymore
- Remove old variables from conf.py, update openstackdocstheme
requirement.
- Remove hacking and friends from lower-constraints, they are
not needed in installed system.
Change-Id: I179d61545169f3d329c746c88dd4d38035d4075d
Add a new tox target to build PDF documentation in accord
with the community goal [0] to have PDF docs available.
Also, only show genindex and search for HTML. These elements
do not make sense within PDF documents.
[0] https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html
Change-Id: Ibbd50276c3879958b0ceb82afcc882716c01b384
Replace it with program-output from
sphinxcontrib-programoutput
Depends-On: https://review.openstack.org/595480
Change-Id: I9b14af568996cc1aaefaeb4d94fe36163c6cbbf2
This patch completes the transition from oslosphinx
to openstackdocs theme in accord with the OpenStack
manuals project migration spec [1].
[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Change-Id: I72be6303f9be77c0461eaacbc61bad8372546fb5
Partial-Bug: #1706181
Needed-By: I8964d066bb838fabbe94239ac108bff884c6ff76
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
The following file(s) added utf-8 encoding but never used. So we can
remove them at all.
doc/source/conf.py
releasenotes/source/conf.py
Change-Id: I8ffd8ad1a9638a80696c3d0775372de5be642fbc
OpenStack has dropped the incubation notion, so labeling this as an
incubated project in the docs is confusing.
Change-Id: I9f9c70f9d6fd9156da66280183fa933f72b59d7a
Since manila is now an incubated project, use oslosphinx together with
the incubated theme.
Unset html_static_path since there's currently no static file and sphinx
warns otherwise.
Change-Id: Icfbf2c0ee214da870c3c711a34b6a649e9878659
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
Closes-Bug: #1368910
