| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
The autoprogram-cliff directive has a habit of producing text like
This command is provided by the $me plugin.
which doesn't make any sense.
Cliff recently added a config option whereby consumers can let it know
who $me is so it can suppress that message where appropriate (while
still producing it for $plugin, as intended).
Depends-On: https://review.opendev.org/692464
Change-Id: I0d580fb1d34dd56740eb6d976caa795e0e951047
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
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.
Depends-On: https://review.opendev.org/729744
Change-Id: Id3989cabdbf2204821531b00149aa0f1cb8a4955
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
OpenStack is dropping the py2.7 support in ussuri cycle.
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add python-requires to setup.cfg so that pypi and pip know
about support Python version
- Remove ancient sections from setup.cfg
- Remove version_info setting from conf.py, openstackdocstheme does this
automatically nowadays.
Change-Id: I5b9c159752c932f874015f20822862c70562c2bd
|
| |
|
|
|
|
|
|
|
|
|
|
| |
The help page for network auto allocated topology had a link to a
newton-era networking guide document that has been superseded and is
now maintained in the neutron repository.
This commit adds 'neutron' to the openstackdocstheme configuration so
that the :neutron-doc: role works, and updates the link to point to the
modern version therein.
Change-Id: I5bcb40e265b22f15ff2f5ca4936160e231bb4075
|
| |
|
|
|
|
|
|
|
|
| |
Sphinx errors have been fixed in the plugin projects for octavia, rsd,
trove, watcher, and zun, so we can now use autoprogram-cliff to generate
the docs for those.
Change-Id: Ia7790c5e86957afd0aec8f9a04ffc7aa968b4eeb
Story: #1735016
Task: #37241
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
We would like to use autoprogram-cliff to generate full docs inline for
each plugin. But for the following projects, that breaks the build:
- octavia
- rsd
- trove
- watcher
- zun
For those projects, we're using list-plugins instead, because that
builds, and it's better than nothing; but it only provides summaries of
the commands.
So with this commit, we add a link to the plugin documentation from the
actual plugin project where such documentation exists, which currently
is just:
- octavia
- watcher
- zun
(For rsd, I couldn't find openstack-published docs at all; for trove,
published docs exist, but the osc plugin isn't documented.)
Change-Id: I7c826ecef4319bead239e11b5f975302b2f24d1b
Story: #1735016
Task: #37244
|
| |
|
|
|
|
|
|
|
|
|
|
| |
This fixes the docs bug link generation for the normal docs
and release notes docs.
The requirement on openstackdocstheme is bumped to 1.23.2 to
pick up fix I2ed164b9b0badade702c50543ac1a5eea4d1867b.
Change-Id: I89711a391ee0fb7e40c1fbf83f950e2b582358d9
Story: #2005467
Task: #30546
|
| |
|
|
|
|
|
|
|
| |
This fixes local building of the documentation using tox, and allows the
gate to stop relying on pbr and move completely to the new docs PTI.
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html
Change-Id: I485acda07098a435753e91c1ca45e586de199c35
|
| |
|
|
| |
Change-Id: I832eade2ddab754664e5f57b9764e524e655e616
|
| |
|
|
| |
Change-Id: I413a6d059f4eb751ca5c8b5a9b61740ac93680b1
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
'cliff', the command line library used by 'osc_lib' (and, thus,
'python-openstackclient') recently gained a Sphinx extension to
automatically document cliff commands. This allows us to use the
documentation we already have in code instead of duplicating it in the
documentation.
Introduce the use of this, starting with the 'server' commands. This
requires extending the descriptions for two commands to ensure no
information is lost.
Change-Id: If701af8d5a3f78f4b173ceb476dd0c163be4b6ca
|
| |
|
|
|
|
|
|
|
|
| |
https://review.openstack.org/473964 moved the man page rst from
the doc/source/man directory into doc/source/cli/man, so we need to
adjust the path in conf.py to avoid issues when running:
python setup.py build_sphinx -b man
Change-Id: I1ab09bf298beef756b233c7e17bf052f7af4de51
|
| |
|
|
|
|
| |
Change-Id: Iee591504ba5d7506ba41a9faaa1c293a5fe2db6a
Depends-On: Ifc5512c0e2373cf3387e0e0498268eab092e52bb
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
|
| |
|
|
|
|
|
|
|
|
|
|
| |
This is unnecessary as pbr has since been fixed. It was causing a broken
build as it didn't respect the '[pbr] autodoc_tree_excludes' setting in
setup.cfg.
The 'openstackclient/volume/v3' directory is an empty module containing
only an '__init__' file). Empty modules = unhappy autodoc, thus, this
module is ignored.
Change-Id: Ie355b14c14b7badccb5c25f7c17edbc5e4b3804f
|
| |
|
|
|
|
|
| |
This fixes Debian bug:
https://bugs.debian.org/826676
Change-Id: I638488448a4d6e644ab0e6deaebd65c92fa7904a
|
| |
|
|
|
|
|
|
| |
conflicting command names are a painpoint, so is manually updating
a list. let's autodocument the commands that are being use by
existing osc supporters.
Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
|
| |
|
|
|
|
|
| |
Sphinx was always using (o)penstackclient for the prefix so the index
wasn't very useful.
Change-Id: Ie9f5d7fe428142bdb8027b422e3023418b48c428
|
| |
|
|
|
|
| |
Also fixes a few small docstring syntax errors
Change-Id: I85eb968e32c1191cf5d60d02deff2ab7f3291074
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
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
|
| |
|
|
|
|
|
| |
Rather than host different and possibly out of date versions of
static and theme files, use oslosphinx to generate the docs.
Change-Id: I7eadc8e40aa10cc26cfd6aece6efa5d13fee70b0
|
| |
|
|
|
|
|
|
|
|
|
|
| |
To make things more consistent across all openstack projects, the
developer docs should be upgraded to the newer template used by
keystone and keystoneclient (and other projects).
I dropped in the necessary static files and themes, and updated
the config file to make the changes at build time.
Change-Id: I5a268cff3cd5af29ad712705d540b9d1d6667d56
Partial-Bug: #1331304
|
| |
|
|
|
|
|
|
| |
* rename HACKING to HACKING.rst and refer to the common OpenStack HACKING file
* add the barest of pointers to the wiki, etc. to the source docs
* add a bare-bones man page
Change-Id: I80e5b972af645f14ef17ae87f182ab09cb08dabe
|
| |
|
|
|
|
| |
Fix some pep8 issues in doc/source/conf.py and tests/test_shell.py make the code looks pretty.
Change-Id: I927f03aff4190f1ac30eb56e7c545de555978c31
|
|
|
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/source and build results go in project/doc/build.
Change-Id: I925e687254bac9e06c2c520f4fc35a083e21c4ca
|
