Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* parallelizing building of documents
Update Sphinx version as well.
Remove the doc requirements from lower-constraints, they are not
needed during installation.
openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.
Set openstackdocs_pdf_link to link to PDF file.
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
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: Ic7c901ff19aa073b6e003ccb95aaf77886f20152
Currently with sphinx 2.2.0 the docs job is throwing a warning
that the html_static_path entry does not exist. We treat warnings
as errors so this causes the job to fail.
This change comments the html_static_path entry in conf.py since
the path currently does not exist so it appears to be unused.
Change-Id: Ib2c74f4f37855cec250d09b23c45b5b7fde44c8d
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: I161a3983e23b0ae50c232eb63ca78f8fd230e91e
In a previous change [0] when warning-is-error was added, the
sphinx todo extension was causing errors with duplicate
registration. However with the recent changes between pbr and
sphinx, this extension no longer throws a duplicate error when
using warning-is-error and we can add it back in.
[0] https://review.openstack.org/#/c/439819/
Change-Id: Ib71f156eb179bdfe07479441334ea0efcc594924
Due to latest change in docs the old urls don't work and cause gate
failures. Fix it to reflect the new locations.
Change-Id: I5b02d7fa40b5892ee0c66bba8dd642dde9a6637e
Depends-On: I7e170275fd422345505b7282b52899d08c7a4172
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.
[0]https://review.openstack.org/#/c/472275/
Change-Id: I5150a456df75d61035a6f00366fa70bd4ec83457
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
Change-Id: I21ff7fe4da885d590303105c311aa9792fdaef2a
This change adds the "warning-is-error" setting
to setup.cfg in order to enforce strict doc validation which
will cause the build to fail if any warnings are thrown.
This also removes the redundant loading of the todo plugin
warning that shows up while running 'tox -e docs' with
'warning-is-error' enabled.
Change-Id: I33c110073feec7dd38ab75981d6f97c654852f37
There was an old comment left regarding this bug:
https://bugs.launchpad.net/pbr/+bug/1260495
which was fixed over a year ago but left over.
This change removes the comment and related extension
and adds the referenced pbr setting.
Change-Id: Ib334c136835a9b5b43cabe13b9616cce45e578e0
When building keystonemiddleware docs, the following warning
is currently emitted:
WARNING: no "man_pages" config value found;
no manual pages will be written
This change comments out man_pages since it was only
specifying an empty list, and the warning no longer appears.
Change-Id: Ia650abc6cb3b3bcf36469cae9d8c20e83d0317a4
The openstack.org pages now support https and our references to
the site should by default be one signed by the organization.
Change-Id: I8521461203fe40e4576f4de7cfb500bd64027d6d
Let's use sphinx extensions to generate the config options instead of
updating them manually.
The following options will no longer appear since we use auth plugins
now:
auth_admin_prefix
auth_url
auth_host
auth_port
auth_protocol
identity_uri
admin_token
admin_user
admin_password
admin_tenant_name
Change-Id: I0a6eac26f93bfb1c2cbba17a98629108915f78c6
When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.
Change-Id: Ic2a6031a9b098e39c95669ca6fa2b92e536dc2ad
Closes-Bug: #1552251
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Closes-bug: #1529836
Change-Id: I3f78fff64f100aa7d435c830a2a913a521af698e
We pass the service catalog and token data through to consumers via
headers, with the auth plugin work we can create clients that are
authenticated with the incoming token and service catalog.
DocImpact: A new environment option is passed out of auth_token
middleware called `token_auth` which is an authentication plugin that
can be used with a session in a service.
Implements: blueprint create-auth-plugin
Change-Id: I549a421fc73f00126f6ac5f4b5911de2e32de825
There are no intersphinx mappings used within the documentation so we
should remove the links so that they don't try to download.
Related-Bug: #1353817
Change-Id: I24edc4d88e9badd2b92ea124ebe960abc7d2d51c
Start using oslosphinx to generate the themes and static content,
rather than hosting our own copies.
Change-Id: I014ef5f974835d52dbb4598c7d357ecafa1da8a2
Andreas Jaeger