RETIRED, python utility to manage a tripleo based cloud
Go to file
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
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.html
https://etherpad.openstack.org/p/train-pdf-support-goal
https://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>
2019-09-11 16:33:21 +02:00
config-generator Add minion installation 2019-06-21 07:44:21 -06:00
doc PDF documentation build 2019-09-11 16:33:21 +02:00
releasenotes Merge "New command "openstack overcloud node unprovision"" 2019-09-06 06:31:41 +00:00
tools Avoid tox_install.sh for constraints support 2017-12-02 16:51:15 +00:00
tripleoclient Merge "Fix race in execution finishing" 2019-09-07 01:30:25 +00:00
zuul.d Merge "Add minion job" 2019-08-13 00:59:07 +00:00
.coveragerc Update .coveragerc after the removal of respective directory 2016-10-18 17:37:29 +05:30
.gitignore Add minion installation 2019-06-21 07:44:21 -06:00
.gitreview OpenDev Migration Patch 2019-04-19 19:42:47 +00:00
.mailmap Initial commit 2015-03-17 09:33:52 -04:00
.stestr.conf Switch to stestr 2019-01-04 17:31:21 +00:00
CONTRIBUTING.rst PDF documentation build 2019-09-11 16:33:21 +02:00
LICENSE Initial commit 2015-03-17 09:33:52 -04:00
README.rst PDF documentation build 2019-09-11 16:33:21 +02:00
babel.cfg Initial commit 2015-03-17 09:33:52 -04:00
bindep.txt Set policycoreutils package name for RHEL/CentOS 8 2019-09-09 10:18:58 +00:00
lower-constraints.txt Run Validations with ThreadPoolExecutor 2019-08-08 16:31:30 +02:00
requirements.txt Run Validations with ThreadPoolExecutor 2019-08-08 16:31:30 +02:00
setup.cfg Merge "New command "openstack overcloud node unprovision"" 2019-09-06 06:31:41 +00:00
setup.py Updated from global requirements 2017-03-07 02:06:19 +00:00
test-requirements.txt Merge "Update hacking version" 2019-01-17 18:09:31 +00:00
tox.ini PDF documentation build 2019-09-11 16:33:21 +02:00

README.rst

About tripleoclient

General information

tripleoclient is an OpenStackClient (OSC) plugin implementation that implements commands useful for TripleO and the install and management of both an undercloud and an overcloud.

See the TripleO Documentation for details on using tripleoclient.

See the Release Notes

Team and repository tags

image