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:
- copy the docs testenvs' dependencies from
Ib3bb34191582f581c28f2f8a0281cf3ae44003e8
- do not place unrelated to the docs testenvs entries for the
test-requieremets.txt, add missing flake8
- add the missing sphinxcontrib-mermaid docs requirements
- render mermaid diagrams only for html builds, for PDF use a hand-made
quick and dirty approximation instead (if used for PDF builds, it
fails on the py3 deprecated warn() methos)
- add the project architecture and components into the main ToC, omit
rendering additional contents pages for PDF builds
- add a new pdf-docs environment to enable PDF build,
- sphinxcontrib-svg2pdfconverter is used to handle SVG properly,
- Add requirements for sphinx and poke it for openstackdocstheme,
- disable usage of xindy for tex,
- do not generate empty pages,
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>
* update README.md to make it easier to get started with TripleO doc contributions
* convert README.md to README.rst with pandoc
* nuke README.md so we don't duplicate information
* update setup.cfg to account for removal of README.md
Change-Id: I7611959b2ea2b19010f0ef05fa3d54d4abfab806
Ghanshyam Mann