Commit Graph

10 Commits

Author SHA1 Message Date
Michal Nasiadka 58a6bb69a4 docs: Change Storyboard links to Launchpad
Change-Id: I84d5a3b516f3e46b82e4a87b00013c5c942b96e8
2023-10-03 14:17:45 +02:00
niuke 6bc060ee06 remove unicode literal from code
Change-Id: I8d43a5864b5deb37be6c850115aa7edfe8ae9d30
2022-08-06 20:54:06 +08:00
Andreas Jaeger a7f2e2102d 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.

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: Ic07c726697a8ed7d0a837bf0d16feec222e805f1
2020-05-21 17:13:23 +02:00
Andreas Jaeger 0df6b5be96 Update for Storyboard
This project uses storyboard for new bugs, so fix a few places:

* Fix the "Report a bug" links so that bugs get reported against
  storyboard, not launchpad.
* Update CONTRIBUTING to link to storyboard.

Change-Id: I2760db2e14015407af46ec52ffe4883262ccb5ba
2019-08-02 10:53:32 +02:00
pengyuesheng 749a792eb4 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: I1e6e570d4db575d611212198d11ee4b84884ab23
2019-08-01 09:41:35 +08:00
deepakmourya d71f6c348a 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: I980ad3f6468e0d8d984c27d367bd6546f78ee113
2017-11-17 03:48:27 +00:00
rajat29 f47a6f71cd Switch from oslosphinx to openstackdocstheme
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: Id7b352dc0c72a79482e77f92f6b588e5760ad754
2017-07-11 04:15:07 +00:00
Andreas Jaeger 90251b5452 Enable release notes translation
Releasenote translation publishing is being prepared. 'locale_dirs'
needs to be defined in conf.py to generate translated version of the
release notes.

Note that this repository might not get translated release notes - or
no translations at all - but we add the entry here nevertheless to
prepare for it.

Change-Id: I906c9d3c947ab5eba2ffe6a7485b8d235560a662
2016-10-13 19:37:13 +02:00
pawnesh.kumar 95015896b0 Fix PEP8 issues, OpenStack Licencing and Version details
Change-Id: I77ed5ec049abcb4cb607c11f504b64baa2914b5e
2016-10-08 20:11:22 +00:00
Eli Qiao c1b63cdac0 Add reno to Magnum
Introduce reno to handle release notes as files in-tree.

Also added documentation on how to add re for changes, after this we
will require changes to add reno if they have some significant changes.

Implements: blueprint add-reno-for-release-management
Change-Id: Ifc18b78ab5ce89375b85f6ac4344ffafa7f1c48b
2016-04-05 08:45:43 +08:00