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.
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.
Disable openstackdocs_auto_name to use 'project' variable as name.
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.
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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: Ie14b87a1e67a7b4351f17a2f0687bcfe5a4b2133
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
know about the requirement
- Remove obsolete sections from setup.cfg
- Update classifiers
- Update requirements, no need for python_version anymore
- Switch to using sphinx-build
- Cleanup */source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Use mock from unittest;leave it in test-requirements for now since
otherwise lower-constraints fails since some repos expect mock to be
installed without requiring it.
- Remove future imports, not needed for python3
- Update to newer hacking version for python3, disable one warning.
Remove hacking requirements from lower-constraints, they are not
needed there.
- Cleanup tox.ini, move basepython to top
- Update horizon requirement for ussuri
Change-Id: I1753bce3ac4fc4248783c0669cacab2e037e62fe
1. 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.
2. pbr hasn't need the hook configuration since forever [2]
[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045
[2] c84876dc0f
Change-Id: I421c88c7c5d2b494443986607e9ddfb87c02bc72
This is a mechanically generated change to replace openstack.org
git:// URLs with https:// equivalents.
This is in aid of a planned future move of the git hosting
infrastructure to a self-hosted instance of gitea (https://gitea.io),
which does not support the git wire protocol at this stage.
This update should result in no functional change.
For more information see the thread at
http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003825.html
Change-Id: I9e1ad83e6a63f5f7d42335342483b1d3262a9dde
1) Replace old http links with the newest https ones in docs.
2) fix a spelling error in HACKING.rst.
Change-Id: Idf087b08fd0053c95b9d9d139fa4269c258c95af
Changeset https://review.openstack.org/#/c/402973/ will introduce
a new badge for this project, including a external svg image. This
update will produce a bug because README.rst file is referenced by
the deploy/installation.rst file. So I moved README.rst content to
deploy/installation.rst to fix it.
Change-Id: I4074baba8e1fea67410710b6565374dcb927e7a2
This patchset puts in open source the code initially made internally.
This dashboard follows the new plugin architecture that Horizon
introduced.
DocImpact
Implements: blueprint watcher-ui
Change-Id: Ic8736b45ae5e111a817f64568ed0534c1521c84d