9 Commits

Author SHA1 Message Date
Takashi Kajinami
1dc635a32c doc: Comment out language option
... because explicit language=None causes the below warning since
Sphinx 5.0.0.

Invalid configuration value found: 'language = None'. Update your
configuration to a valid language code. Falling back to 'en' (English).

Change-Id: I842fd6c1eb5c0e14d85f8eec6078d735fbd506b8
2022-06-07 00:36:10 +09:00
Stephen Finucane
4983b90983 Remove coding comments
Everything is unicode in Python 3.

Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Change-Id: I6a076dc67c461f265ed99878e3959e1992a88189
2022-03-21 18:29:25 +00:00
zhangboye
e6876361f0 remove unicode from code
Change-Id: I791cc993aef832b30c08fdb5bdd7165a074d263f
2021-01-03 16:44:32 +08:00
Andreas Jaeger
e367b6270c 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.

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: I4418f86c3066353d43758118865baf66d1741c79
2020-09-18 12:22:01 -07:00
fuzihao
9b6d1c7e88 Fix pygments style
New theme of docs (Victoria+) respects pygments_style.
Since we starts using Victoria reqs while being on Ussuri,
this patch ensures proper rendering both in Ussuri and Victoria.

Change-Id: Iad418798277b9d7a1190e42e9079080a3d2707f3
2020-05-20 15:27:49 +08:00
pengyuesheng
591c3e2380 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: I0573c7feaea991e6b33bdee6dc358c9206a9bfd8
2019-07-03 15:01:35 +08:00
Andreas Jaeger
f48f421a86 Remove setting of version/release from releasenotes
Release notes are version independent, so remove version/release
values. We've found that projects now require the service package
to be installed in order to build release notes, and this is entirely
due to the current convention of pulling in the version information.

Release notes should not need installation in order to build, so this
unnecessary version setting needs to be removed.

This is needed for new release notes publishing, see
I56909152975f731a9d2c21b2825b972195e48ee8 and the discussion starting
at
http://lists.openstack.org/pipermail/openstack-dev/2017-November/124480.html
.

Change-Id: I623fe918c1e4ddafa93efc91ed550a365cec1cf0
2017-11-16 20:50:07 +01:00
Tim Burke
f323bb4824 Trying out the new releasenotes jobs
Change-Id: I96a29ab48cd7a349d0eb17efce7df097d4174cbe
Depends-On: I5820bb2ffa0e3c65ac846ced97435b7c3086aefc
2017-08-08 22:40:10 +00:00
Tim Burke
ed0858a4e4 Add releasenotes tox env
After this, we need to

* add release notes jobs for python-swiftclient in openstack-infra/project-config
* add release notes links for python-swiftclient in openstack/releases

For the corresponding change in the swift repo, see
I4e5f1ce1fcfbb2943036c821a24a0b4a3a2d9fc8

Change-Id: Iea6ed2ee26873edb3ef10146cdc906cf1a236255
2017-08-08 22:03:59 +00:00