| Age | Commit message (Collapse) | Author | Files | Lines |
|---|
|
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
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 docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Set openstackdocs_auto_name to use 'project' as name.
Change-Id: I138d51ace230a434e76fbe9fbbe97e53212230f3
|
|
Cleanup requirement and set ignore_basepython_conflict = True
in tox to avoid python version conflict warning which going
to be error in future.
Change-Id: Ia749d558df33f475dfdbe7a1f9dfdb30aeba8da0
|
|
2020 came, everyone should be using Python 3 now.
As per the official python support timeline set forth
by the OpenStack TC [1], OpenStack Train (in our case,
kolla 9.x) is the last release that will support python2.7.
[1] https://governance.openstack.org/tc/resolutions/20180529-python2-deprecation-timeline.html
Related bug: https://bugs.launchpad.net/tripleo/+bug/1856678
Merging depends on TripleO team - once they move CI job to CentOS 8 we
can merge.
Implements: blueprint drop-py2-support
Change-Id: Ic459561ab6ab8c62993c044c7a82d887839da289
|
|
Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.
[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045
Change-Id: I6b8897472220e2f45ec3230be8d3f82adacc7c7e
|
|
The is one of community goals that each project should produce a
single PDF file. The pdf should be in the output of openstack-tox-docs
job.
TeX packages are required to build PDF locally, following is
recommended:
* inkscape
* texlive-latex-base
* texlive-latex-extra
* texlive-fonts-recommended
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
Change-Id: Ia0f8b73bcbda6295319f5c8de1aa02a40844207b
|
|
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details
Depend-On: https://review.opendev.org/#/c/663060/
Change-Id: I346c06631ea4ed57ecec94aa31b787c649085346
|
|
This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.
[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper
Change-Id: I7c979dacd89ebead404b751d596ba120b38f00f3
|
|
There's a regression[0] in bandit 1.6.0 which causes bandit to stop
respecting excluded directories, and our tests throw a bunch of
violations. Blacklist this version, but allow newer versions as there is
already a pull request[1] to fix it, and I expect it will be included in
the next release.
[0] https://github.com/PyCQA/bandit/issues/488
[1] https://github.com/PyCQA/bandit/pull/489
Change-Id: I4429614a57fb512fe2bfdf0686c3eff0adc2a2f4
|
|
For compliance with the Project Testing Interface as described in:
[1] https://governance.openstack.org/tc/reference/project-testing-interface.html
[2] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
Change-Id: I302aced3b50b038900375e9632ca7ed136f32914
|
