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.
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 test-requirements.txt, 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: Id86f483b405c8fbc74b89ac085076b55e461d417
- Update project name in link to release notes
- Update project name in config for docs/releasenotes
Story:2007193
Task:38345
Change-Id: Id18ed48a2e8c8b9d1828ef7b43d565a7e78869c1
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
- Use updated project name in titles/text
- Correct text for link to Storyboard (docs)
- Correct capitalization in section headings
- Correct formatting for section headings
Change-Id: I0e335b082c731fbed1f6fd2ea32f082471571be1
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Update conf.py for release notes to include the project
variable, set to the project name. This is so the string
above the left nav renders the project name.
Story: 2004900
Task: 29229
Change-Id: Ia643cc5894fc121c31c35dabce98db9b42af16ad
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
* Add pointers in the main doc to releasenotes pages
* Add publish-stx-releasenotes job
* Add search at bottom of relnotes page to trigger the job
Change-Id: Ia1d72b8d2a47c874e4d1d9131b53a21f6af18b41
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
Also set the theme to alabaster until starlingxdocs is ready
Change-Id: Ib61a6642e5a7f2122600958c6a6a8409c6ec3056
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
Baseline changes to comply with Release Notes Management
based in Reno [0]:
* Use build-openstack-releasenotes job for release notes
(We can't use the OpenStack releasenotes template as it includes
publish jobs, stx needs its own)
* Add newnote tox environment as convenience for creating new release
notes, re-using the releasenotes venv.
[0] https://docs.openstack.org/reno/latest/
Story: 2003101
Task: 26717
Change-Id: I03c426c9a493541a6b0be699bce59c69b3a6f3c3
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>