Commit Graph

7 Commits (701c146bd748bcf9c0228cea593539a3521661ca)

Author SHA1 Message Date
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
wu.chunyang c7ee55db3f Add release note link in README
Change-Id: Id49e0df94f64795f73d1aab2b3a17c935feef872
2018-07-26 09:21:04 +00:00
zhangdebo1987 3358537e83 Change tag link in README to the newest address
Change-Id: I83b79fc17514a54f74f50dea36fbd5e9d9cd7e55
2017-08-03 14:01:35 +08:00
Flavio Percoco c2ca74baf0 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

To see an example of how this would look like check:


Change-Id: Ifec1e95e95a9501e2d44c0c51990ae34870a9198
2016-11-25 14:27:23 +01:00
Ben Nemec a5c9dd47b5 Remove osc boilerplate from the readme
This isn't really relevant to tripleoclient at this point.  Instead,
let's just leave a link to the tripleo-docs as that covers how to
use tripleoclient.

Change-Id: I759d0bd40c60fd6e36923cac4e19b0876aab4ae4
2016-10-19 18:40:59 +00:00
Brad P. Crochet 1823b837cd Cleanup some strangling references to rdomanager-oscplugin
Change-Id: I46e3e0b6c4028789676428eaaa1e4c558346ecf4
2015-09-17 15:54:14 +00:00
Brad P. Crochet 68cf7181b5 Initial commit 2015-03-17 09:33:52 -04:00