Commit Graph

12 Commits (35e3278f6c1e7d292b5a50401463e5ccbfc7efb2)

Author SHA1 Message Date
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
3 years ago
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
3 years ago
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 <>
4 years ago
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
4 years ago
Alex Schultz 81d26455ab Fixup sphinx requirements
Change-Id: I700fe5deeee15086dc6ecabb69e63dc8a5cd7898
4 years ago
Kamil Sambor 78b7a9d86b Update sphinx requirements for python 3.x
Change-Id: Ic77607fb0c3e23774ef3c5d71a1883ebb12a5c34
4 years ago
OpenStack Proposal Bot 644cfd38c8 Updated from global requirements
Change-Id: Ia04bff113b1d4e0a64239f42a1dab55eac947679
5 years ago
Nguyen Hai 4961bc7d64 Use openstackdocstheme for python-tripleoclient
Apply for python-tripleoclient webpage and releasenotes

Change-Id: I859cb176a95bcd73b0175c30b079a8781f5bf295
5 years ago
OpenStack Proposal Bot 0b5515155c Updated from global requirements
Change-Id: I074657ebe66ca7cb8a483f87b0fc5fd7b09ed745
5 years ago
OpenStack Proposal Bot a0386cf090 Updated from global requirements
Change-Id: Iea01420e9fe086f0b083de400344dc580f7f5654
5 years ago
OpenStack Proposal Bot 74fbe7a985 Updated from global requirements
Change-Id: I3a61a26564e159990e196f2461f937e9e2ab9d7f
5 years ago
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
5 years ago