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.
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: I4af25bbc8d990aa5e70ee63ba7477d2964872b3f
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
* Some other sections are obsolete
- Update classifiers
- Update requirements, no need for python_version anymore
Change-Id: I45b5b8582b67b39823a6e21221c491842b390b96
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
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
job.
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:
https://governance.openstack.org/tc/goals/train/pdf-doc-generation.htmlhttps://etherpad.openstack.org/p/train-pdf-support-goalhttps://etherpad.openstack.org/p/pdf-goal-train-common-problems
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 <bdobreli@redhat.com>
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
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 <bdobreli@redhat.com>
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
This patch removes the documentation for the --neutron-* command line
options that had been deprecated and removed over time.
Change-Id: I72447bffcde92a85b2c3f436806268d1ae94e005
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
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
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
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
Closes-bug: https://bugzilla.redhat.com/show_bug.cgi?id=1243601
Sorin Sbarnea