17 Commits

Author SHA1 Message Date
Natzcheng
d7f0a04826 remove unicode prefix from code
Change-Id: I34c32df7c41afe0412762cc6977e0fb2cbaeb44d
2023-09-27 10:06:37 +08:00
Zuul
3db7662936 Merge "Fix pygments style" 2020-05-20 17:10:35 +00:00
gugug
35f75d3bf6 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: I430184f65f1528dfa15b3e6a7810d062226e70e7
2020-05-20 08:24:18 +08:00
Andreas Jaeger
075cf9aeba Update openstackdocstheme version
Switch to openstackdocstheme 2.2.0 version.

Update Sphinx version as well.

openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.

Set openstackdocs_auto_version to not version the documents and
openstackdocs_auto_name to use project as name.

Set openstackdocs_pdf_link to link to PDF files for the two
guides that build PDFs. 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.

Update copyright.

Change-Id: Ibd4844364d78abd135e5b094beba8f17503fab26
2020-05-19 13:58:41 +02:00
Andreas Jaeger
48cd6edf98 Small cleanups
With newer openstackdocstheme versions, many settings like
html_last_updated_fmt and latex are setup correctly and don't need to
setup in this repo anymore. We require a new enough version, so remove
the obsolete settings.

This repo now requires python 3, so remove python 2.7.x support.

Update hacking to current version supporting python 3.

Change-Id: I238eefeed275fe8115d0e253ca50d38086934b1e
2020-02-22 17:28:31 +01:00
Andreas Jaeger
063cf760c3 Remove display_badge setting
We do not need to disable badge with openstackdocstheme 1.23.1 for
releasenotes anymore, remove it.

Change-Id: Id2c12564b6933a106d7795631c531a6e2a54e2b9
2018-08-24 12:10:36 +02:00
Andreas Jaeger
cb4369bee9 Disable badge
All documents are versionless, disable badge for pointing out releases.

Change-Id: Ie0496a947529416d627baae1a27b84b20d070d13
2018-08-21 14:34:15 +02:00
Christian Berendt
c48a1a425e Update the end year of copyrights to 2018 in conf.py
Change-Id: I2c17ed8dac876639916ca242c0a66617f3356cf5
2018-02-12 08:54:23 +01:00
Andreas Jaeger
3bb9c6fc97 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: Ia6d8fbd7792f87e114caad51bfca2cf0ed3dff3e
2017-11-16 21:25:25 +01:00
Andreas Jaeger
aa284a69c2 Remove reno, add pike releasenotes
Remove reno, we only used it for a single entry so far and since the
manual is now not branching anymore, let's not do use it.

Create a new pike releasenotes page.

Remove unreleased page, we don't need it.

Change-Id: Ieecdf0d16b26267d7ce6bfcba37d25551b226f32
2017-08-02 21:52:38 +02:00
Andreas Jaeger
a1f1748478 Always set bug_project
The openstackdocstheme requires now setting of bug_project, set it up
everywhere.

Change-Id: I778800b8944e3e1d89cdbd1f844c5830a94012d6
Depends-On: Ifd715d1d46d1b1796d79679c9e954d21e9d09455
2017-06-29 22:17:14 +02:00
Andreas Jaeger
b1bad0d43a Simplify conf.py for openstackdocstheme 1.11.0
With the new openstackdocstheme used, we can simplify conf.py.

Also, update our docs for it.

Note that Sphinx 1.6 needs latexmk for building, add it.

Sphinx 1.6 introduces a few new warnings, fix them so that the guides
built.

Change-Id: If2e431725eb54f8be79b9fa4bf9ede2089f321a5
2017-06-27 07:04:30 +02:00
Adam Spiers
58dbdffcf2 prepare to use reno from Pike onwards
A stated goal from the Atlanta PTG this week was to use reno for our
release notes from Pike onwards.  This requires reno to support
configurable sections, which have been added by:

    https://review.openstack.org/#/c/436639

Once this is merged into reno, this commit configures openstack-manuals
so that reno will work with it, and a build of releasenotes/ will
automatically include a reno-generated report via reno's sphinx
extension.

Depends-on: I914572c6a07ca81c54965b4b5a6b6aba50b3a787
Change-Id: Id029f462fb553b3429629b90585e2790734f1bb9
2017-02-23 18:22:25 -05:00
KATO Tomoyuki
597d7f756f [reno] update release notes URL
* use https instead of http
* fix target page name
* fix target URL

Change-Id: I1a5d7267a37d5ec1958fb59636d369daa7d1e512
2017-02-15 08:46:03 +00:00
Andreas Jaeger
6a01aa42d1 Prepare releasenotes for publishing
Move release notes into releasenotes and add tox target so that
infra scripts will publish them to
docs.openstack.org/releasenotes/openstack-manuals

Infra change: Icbe135e37c78e0a3a1c6d3243f7128c0b881325d

Note that the directory layout here is this way on purpose - we want to
reuse the same jobs other repos use, just the difference is we're not
using reno for this.

Change-Id: I00a53d8b3d9bef28b480be22af2e6647fa26448a
2016-03-18 12:46:15 +01:00
Andreas Jaeger
cbeb4d5c5b Revert "Add reno for release-notes"
As discussed via email, let's do this on a smaller scale.

This reverts commit 9432a6da0cc341a879bc6f4ac48380248355e77a.

Change-Id: I27e9cd06c5d69917abe452e873873683e10c282a
2015-11-10 14:49:13 +00:00
Andreas Jaeger
9432a6da0c Add reno for release-notes
Add renote to automatically generate release notes - the same way other
OpenStack projects do it.
For details see
http://lists.openstack.org/pipermail/openstack-dev/2015-November/078301.html

Change-Id: Iac8f34ae3490b7788c989b17be3e6a616e65c676
2015-11-07 17:34:29 +01:00