This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Update classifiers
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine
- Remove unneeded test-requirements.txt file
- Use basepython=python3 for testenv, remove it elsewhere
Change-Id: I2659000c905b3de2f37bd88ab348d2f45e0968cc
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>
We don't use python build_sphinx anymore, replace with sphinx-build
according to PTI. Remove related configuration from setup.cfg.
This repo builds only docs, so no need for a separate
doc/requirements.txt file, remove its usage.
Cleanup requirements files, we need only requirements for building docs.
Update conf.py for newer openstackdocstheme.
Change-Id: I3f37375b77aaf2f652a69d396a2bc22fb7a7ee40
For the stable release, get the name from the website, to be always
fresh, and not necessary to edit the file
Change-Id: Ia4430c4cf7b41e69bbdcb593fadc891df6017bf0
The commands used by constraits need at least tox 2.0, update to reflect
reality, which should help with local running constraints targets.
Change-Id: I069abc89dcd21b072a25c4375af7d78e5123b489
One conf.py was failing to pass falke8 and the other one was excluded.
Removed exclusion and fixed these filex as this is a more future proof
approach.
Before this change a clean clone of this repository would have failed
on `tox -e pep8`.
Change-Id: Ib8337aa6129acb515e33846c0635b582d1eedb8b
We want to default to running all tox environments under python 3, so
set the basepython value in each environment.
We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.
We do not want to set the override once in testenv, because of that
breaks the more specific versions used in default environments like
py35 and py36.
Change-Id: I574364f9b072387883bedfc7404072642041f380
* Move _custom & _templates at root, so both doc/ and deploy-guide/
can use it.
* Update tox.ini to generate deploy-guide.
* Very basic structure of deploy-guide.
* Removing duplicated _templates parameter from config.py.
Change-Id: Id7b4c22d188fd4f2646ec25194767c3a7afa97c7
The built html docs should be under doc/build/html so that the jenkins
jobs know where to get them from in order for publishing.
Change-Id: I184ffeb1239c444a496bd340406951baa0c68eca
Andreas Jaeger
yatinkarel