summaryrefslogtreecommitdiff
path: root/releasenotes/source/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* Blacken everything elseStephen Finucane2023-05-101-26/+30
| | | | | | | | | | Black used with the '-l 79 -S' flags. A future change will ignore this commit in git-blame history by adding a 'git-blame-ignore-revs' file. Change-Id: I356643d06b2cd408ccaedfe02b858aea55388949 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* remove unicode prefix from codeniuke2022-08-151-8/+8
| | | | Change-Id: I0b1ca4237de61b70c694f36e1956e71a2a6b39a4
* Don't fail on extlinks warnings for reno buildDr. Jens Harbott2022-02-031-0/+8
| | | | | | | | | | | | With Sphinx==4.4.0 some "helpful" warnings were introduced when an external link could be replaced by a macro, like for :lpbug:. Sadly we have a very high number of existing release notes that trigger these warnings and no good way to fix them retrospectively, because would mess up their mapping to releases. So we change the logging for the sphinx.ext.extlinks to ignore these warnings for now. Signed-off-by: Dr. Jens Harbott <harbott@osism.tech> Change-Id: I709de5e454434b8790a68d9e67ca1432387b21ab
* Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-201-8/+4
| | | | | | | | | | | | | | | | | | | | | | | 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. 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. Set openstackdocs_auto_name to use 'project' 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. Depends-On: https://review.opendev.org/729744 Change-Id: Id3989cabdbf2204821531b00149aa0f1cb8a4955
* Fix docs bug link to go to storyboard rather than launchpadMatt Riedemann2019-04-161-2/+1
| | | | | | | | | | | | This fixes the docs bug link generation for the normal docs and release notes docs. The requirement on openstackdocstheme is bumped to 1.23.2 to pick up fix I2ed164b9b0badade702c50543ac1a5eea4d1867b. Change-Id: I89711a391ee0fb7e40c1fbf83f950e2b582358d9 Story: #2005467 Task: #30546
* Remove setting of version/release from releasenotesAndreas Jaeger2017-11-161-8/+3
| | | | | | | | | | | | | | | | | | 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: Ia0c8d7dc346182fde095eebb82eeeb70fc1b9770
* Update the documentation link for doc migrationlingyongxu2017-09-211-1/+1
| | | | | | | This patch is proposed according to the Direction 10 of doc migration(https://etherpad.openstack.org/p/doc-migration-tracking). Change-Id: Ieca93d77bfc5e54486312f16122cc12c5bda0934
* Use openstackdocstheme in release noteAkihiro Motoki2017-07-061-2/+9
| | | | | | | | | | | | | | | | | | | In the release notes build, openstackdocstheme is specified in the sphinx extension list, but it is actually not used. This commit configures openstackdocstheme as suggested in the openstackdocstheme document. Also specifies display_toc False in html_theme_options. This prevents openstackdocstheme to add the local TOC automatically. OSC has several releases during a single development cycle and it leads to a long TOC at the top of individual pages. It loses the readability and we can see version numbers in the left sidebar, so we can safely disable the local TOC in the release notes. [1] https://docs.openstack.org/openstackdocstheme/latest/ Change-Id: Iae08d309f7589bb13a1766f6fded70673ba24047
* switch to openstackdocsthemeDoug Hellmann2017-06-261-1/+2
| | | | | | Change-Id: Iee591504ba5d7506ba41a9faaa1c293a5fe2db6a Depends-On: Ifc5512c0e2373cf3387e0e0498268eab092e52bb Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* Enable release notes translationAndreas Jaeger2016-10-061-0/+3
| | | | | | | | | | | | 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: Ib265f919e176f048f6e56bde47db3d99b3dd993e
* Update the description of project in releasenotes.qtang2016-07-291-1/+1
| | | | Change-Id: I1fe0e52d2e049d34666a6d94bac1d85b91a78b19
* Fix release note links to (now) external docsDean Troyer2016-06-061-0/+20
| | | | | | | | | | | | | Moving the old release notes into the Reno releasenots tree broke the embedded :doc: roles. Restore these using sphinx.ext.extlinks to manage the URL to the OSC docs. Add the following aliases: * lpbug - generic Launchpad bug :lpbug:`123456` * oscbp - OSC blueprints :oscbp:`Blue Print <bp-name>` * oscdoc - OSC Docs :oscdoc:`Comamnd List <command-list>` Change-Id: Iecfdd666d961c35f0ccb3b9f10df1d2620cb099f
* Add reno for release notes managementDean Troyer2015-12-021-0/+282
Change-Id: Iaaf3f9ca7cb431e41adfb2a052e01e2240a63a07
View Lorry Controller Status