Commit Graph

37 Commits (5084da819697eaa6d36294e1c6498ff194498ea9)

Author SHA1 Message Date
Sorin Sbarnea 04c1466c44 Enable pylint
Related-Bug: #1910543
Change-Id: I8cba98b97ebb6d18fce84c86cceb5c30b93dd194
2021-01-08 13:40:58 +00:00
Andreas Jaeger f6c366ebaa 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

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
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

Change-Id: I4af25bbc8d990aa5e70ee63ba7477d2964872b3f
2020-05-22 17:23:28 +00:00
Andreas Jaeger 655e0178a1 Cleanup py27 support
Make a few cleanups:
- Remove python 2.7 stanza from
- 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
  * Some other sections are obsolete
- Update classifiers
- Update requirements, no need for python_version anymore

Change-Id: I45b5b8582b67b39823a6e21221c491842b390b96
2020-04-04 17:19:56 +02:00
Alex Schultz 6745f10279 Fix command docs generation
Since we added a tripleoclient.v2 namespace, we need to update the auto
doc namespace so it finds the commands.

Change-Id: I7b5266e00af68e1d6efc9cc022fb97d002f5241b
Closes-Bug: #1866410
2020-03-09 13:10:10 -06:00
Bogdan Dobrelya dd02f75d56 PDF documentation build
The is one of community goals that each project could produce a
single PDF file. The pdf should be in the output of openstack-tox-docs

The list of changes:
- add a new pdf-docs environment to enable PDF build,
- sphinxcontrib-svg2pdfconverter is used to handle SVG properly,
- poke versions for sphinx and openstackdocstheme,
- disable usage of xindy for tex,
- do not generate empty pages,
- only build html for toctree and other content-less for pdf sections,
- adjust README to firstly contain "About tripleo" then team & repo tags
  for the better view in PDF-generated contents.
- move the Contributing chapter closer to the beginning for the better
  view in the long list of generated contents.

More about the goal:

TeX and  few more packages may be needed to build PDF locally
(listed for bindep):

inkscape [doc platform:dpkg]
fonts-liberation [doc platform:dpkg]
texlive-latex-base [doc platform:dpkg]
texlive-latex-extra [doc platform:dpkg]
texlive-xetex [doc platform:dpkg]
texlive-fonts-recommended [doc platform:dpkg]
xindy [doc platform:dpkg]
latexmk [doc platform:dpkg]
texlive [doc platform:rpm]
texlive-fncychap [doc platform:rpm]
texlive-titlesec [doc platform:rpm]
texlive-tabulary [doc platform:rpm]
texlive-framed [doc platform:rpm]
texlive-wrapfig [doc platform:rpm]
texlive-upquote [doc platform:rpm]
texlive-capt-of [doc platform:rpm]
texlive-needspace [doc platform:rpm]
texlive-polyglossia [doc platform:rpm]
latexmk [doc platform:rpm]
python3-sphinxcontrib-svg2pdfconverter-common [doc platform:rpm]
librsvg2-tools [doc platform:rpm]
librsvg2-bin [doc platform:dpkg]

Change-Id: Ib3bb34191582f581c28f2f8a0281cf3ae44003e8
Signed-off-by: Bogdan Dobrelya <>
2019-09-11 16:33:21 +02:00
pengyuesheng 7de33c1340 Bump the openstackdocstheme extension to 1.20
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: Ibd6b3a191c6bee5b094de94680bab6df07616deb
2019-08-01 09:49:37 +08:00
Zuul ae373bc0d5 Merge "Fixup sphinx requirements" 2019-06-26 22:51:06 +00:00
Bogdan Dobrelya a37cd7c9d0 Allow deeper levels of nesting for pdf builds
Change the defaults for the max of a 5 of \begin...\end stanzas,
up to a 10.

Change-Id: I52ef17bd87cbcde7f9dc34e8b1bb874581d0917d
Signed-off-by: Bogdan Dobrelya <>
2019-06-24 16:56:05 +02:00
Alex Schultz 81d26455ab Fixup sphinx requirements
Change-Id: I700fe5deeee15086dc6ecabb69e63dc8a5cd7898
2019-06-20 13:19:41 -06:00
Kamil Sambor 78b7a9d86b Update sphinx requirements for python 3.x
Change-Id: Ic77607fb0c3e23774ef3c5d71a1883ebb12a5c34
2019-06-05 08:01:44 +02:00
Brad P. Crochet 4b6633bf9b Use cliff autodoc generation
Currently, there is an issue with the 'overcloud container image prepare'

Change-Id: If5d784af413decc72afe8ba3bdc8a20f0c4fb290
2019-02-01 20:39:58 +00:00
OpenStack Proposal Bot 644cfd38c8 Updated from global requirements
Change-Id: Ia04bff113b1d4e0a64239f42a1dab55eac947679
2018-03-27 22:21:14 +00:00
Nguyen Hai 4961bc7d64 Use openstackdocstheme for python-tripleoclient
Apply for python-tripleoclient webpage and releasenotes

Change-Id: I859cb176a95bcd73b0175c30b079a8781f5bf295
2018-03-20 13:58:40 +09:00
OpenStack Proposal Bot 0b5515155c Updated from global requirements
Change-Id: I074657ebe66ca7cb8a483f87b0fc5fd7b09ed745
2018-03-17 09:06:21 +00:00
OpenStack Proposal Bot a0386cf090 Updated from global requirements
Change-Id: Iea01420e9fe086f0b083de400344dc580f7f5654
2018-03-13 08:25:03 +00:00
OpenStack Proposal Bot 74fbe7a985 Updated from global requirements
Change-Id: I3a61a26564e159990e196f2461f937e9e2ab9d7f
2018-03-11 18:08:19 +00:00
Guoqiang Ding 088b6de3a1 Update new documentation PTI jobs
For compliance with the Project Testing Interface as described in [1].
For more detailed information, please refer to [2].


Change-Id: I4999e2eceb46deec1385cb6376762de9e2fbf6e3
2018-03-08 19:20:05 +08:00
Stephen Finucane 3653a6006f Use Sphinx 1.5 warning-is-error
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. Enable this.

Change-Id: I981b05275e1a75e3c42ea3ef24812cded0cefc0d
2017-04-26 08:53:45 +00:00
Jenkins 5137f3135d Merge "Remove documentation for removed neutron command line options" 2017-03-03 13:56:51 +00:00
Rajiv Kumar f03583a3f3 Remove link to modindex
The documentation build does not generate any module index, thus
remove the link to the page.

Change-Id: I1e66344f5087b7c1bd2e6fde3fc020b23373e06c
2017-01-27 10:15:53 +05:30
Brent Eagles a9c9885254 Remove documentation for removed neutron command line options
This patch removes the documentation for the --neutron-* command line
options that had been deprecated and removed over time.

Change-Id: I72447bffcde92a85b2c3f436806268d1ae94e005
2017-01-17 13:57:29 -03:30
Ana Krivokapic b24c9d5101 Fix doc page for overcloud deploy
Change-Id: I346b6863545823bc4e8ecb6ad26b26c375f24eba
2016-08-22 13:47:17 +02:00
Jenkins ca035844b3 Merge "[Trivial] Remove executable privilege of doc/source/" 2016-05-27 18:35:09 +00:00
Miles Gould 6e458be6d8 Document --initial-state param on baremetal import
Change-Id: I934b1d00b90c714c291a76175acc20961b176744
2016-05-23 16:22:38 +01:00
ZhiQiang Fan 37068f27de [Trivial] Remove executable privilege of doc/source/
It is a configuration file, rather than a script.

Change-Id: Ib276acae5e4cfb336ce5415e77104200a8e259be
2016-04-29 22:50:51 +08:00
Lennart Regebro 0821856178 Add support for an answers file
Adding an --answers-file parameter to overcloud deploy and
overcloud update that takes a YAML file:

   templates: ~/templates
     - ~/test-env1.yaml
     - ~/test-env2.yaml
     - ~/test-env3.yaml

Change-Id: I623143924951d02fcc9179c1da7705b4b7b551b7
2016-01-18 14:26:25 +01:00
Brad P. Crochet d0b54c533d Remove parameter defaults
Remove parameters that have sane defaults in the Heat templates.
In order to change these, one should use an environment file rather
than passing args to the deploy command. These commands should now
be considered deprecated in favor of the environment file.

Change-Id: Idbf85d455f348ed2ab9b34fe1dc95faec427a13f
Depends-On: Ifd740c50ee0e48e0cf50d9ebd9cc282155cb3a6d
2015-10-29 08:12:51 -04:00
Dougal Matthews 6abf557aa1 Remove Tuskar support
This change removes Tuskar support from the following commands:

    - openstack overcloud deploy
    - openstack overcloud node delete
    - openstack overcloud update stack

This removal is due to the limiting nature of Tuskar, we can achieve everything
we need and more without it. The change also removes python-tuskarclient from
the requirements and if the Tuskar CLI (openstack management commands) is
required it will need to be installed independently.

This change is dependant on the Tuskar examples being removed from the
documentation. These are removed in the dependant change ID below.

Depends-On: I2d4aa114156c5bafb003e6a67862ed6d1449fd98
Change-Id: Ic6fd4568054fe91b8fc898728022a7d7ed8cf3cf
2015-09-28 07:50:48 +00:00
Jenkins 1bd3c74c0a Merge "Cleanup some strangling references to rdomanager-oscplugin" 2015-09-23 21:20:33 +00:00
Marek Aufart 57ce8fad01 Add image name option to bm boot config
In order to be able configure bm deploy with various images,
option --deploy-kernel and --deploy-ramdisk were added to baremetal boot
config command.

Change-Id: I43a7de21f965bc344a9eea20b289182c875b6a83
Closes-Bug: rhbz#1249836
2015-09-18 12:00:53 +00:00
Brad P. Crochet 1823b837cd Cleanup some strangling references to rdomanager-oscplugin
Change-Id: I46e3e0b6c4028789676428eaaa1e4c558346ecf4
2015-09-17 15:54:14 +00:00
Lennart Regebro 85c4bad1ea Change libvirt default to kvm
Also only list qemu and kvm as options, as those are the only
ones we support, even though others would be passed through
and might work.

Change-Id: Ifaedd7d3d2cc5fd03465b9110f865daaca6e9fd0
2015-09-03 00:17:28 +02:00
Lennart Regebro eebb8e2630 Add command option descriptions
Add command option descriptions for the deploy overcloud command.

Change-Id: I20815efddd020ab652bd2666cafbdbfbfd637437
2015-08-26 11:30:12 +02:00
Lennart Regebro 57ad4f4534 Rename the "all" commands to "bulk"
Change-Id: Ia6ed32024d6e68c9fff291cfdcb7d6a2762c2c10
2015-05-21 11:17:17 +02:00
Brad P. Crochet c57ef6fdc5 Add man-type documentation pages for rdo-manager commands
Change-Id: I8bf5e62cbe1b563c985712f54abff9b03dd47e48
2015-04-28 22:10:23 -04:00
Brad P. Crochet 12e7d22ddd Fix doc problems so build of docs succeeds
Change-Id: I50f624ef2d0b20161e8e76f88bfe56925f85847c
2015-04-02 11:14:42 -04:00
Brad P. Crochet 68cf7181b5 Initial commit 2015-03-17 09:33:52 -04:00