This change the default docs language conf to 'en'
instead of None.
Closes-Bug: 2033410
Change-Id: I24a47c6e817f977fbb49c81a14da4300223e397f
Signed-off-by: Hugo Brito <hugo.brito@windriver.com>
The requirements that had conflicts have been updated.
The local upper-constraints is no longer being used by tox
since two constraints files with different values for the same
requirements are not supported. To enable this change, some
unnecessary code that required an older version of
oslo.messaging is removed.
Bugbear is also being disabled due to brokeness that can cause
test failures.
Change-Id: If007b7e0ad3c04b78b619542162267cc7d502460
Story: 2004515
Task: 41670
Signed-off-by: Bart Wensley <barton.wensley@windriver.com>
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.
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: I7da2bdaafe86b9eb930202bef3742571daa90e17
- Use updated project name in titles/text
- Correct text for link to Storyboard (docs)
- Correct capitalization in section headings
- Correct formatting for section headings
- Update project name in link to release notes, api-ref
- Update project name in config for docs/releasenotes/api-ref
Story:2007193
Task:38342
Change-Id: I65d4b92deef90c09f7c1f309bf79e454c570c8a1
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
The storyboard and gerrit doc link are error, and git library
redirect to the correct one, this change is to correct all them.
Change-Id: I58fb35cf4bd4edde173c5d7e55bc6ced1ee08d60
Partial-Bug: #1835207
Signed-off-by: junboli <junbo85.li@gmail.com>
doc index.rst:
1. Update intro sentence to read as a complete sentence
2. Remove unused toctree
3. Correct heading levels (impacting side nav and correct rendering
of content)
4. Remove "Indices and Tables" section: genindex page not used,
search searches only index (not useful here)
api-ref index.rst:
1. Update intro sentence to read as a complete sentence
2. Update text around search link for consistency (move to
follow intro)
3. Add heading before toctree for consistency with other pages
release notes:
1. Standardize page title reST markup
2. Remove search (make consistent with other openstack release note
pages)
Story: 2004737
Task: 28803
Change-Id: I11ba3784a5d50953d62f0bc4a08f3f2b308da6b5
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
* Add pointers in the main doc to api-ref and releasenotes pages
* Add publish-stx-api-ref and publish-stx-releasenotes jobs
* Add search at bottom of api-ref and relnotes pages to trigger the jobs
Depends-On: https://review.openstack.org/#/c/608409/
Change-Id: Ide9a7d5829b41191c9127af75c4320f94d82f428
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Also set the theme to alabaster until starlingxdocs is ready
Change-Id: I2d5d4456b3f21ea2c27f6e6b519170482f617fb5
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.
* Remove the unused 'true' tox environment.
[0] https://docs.openstack.org/reno/latest/
Story: 2003101
Task: 26620
Change-Id: Ie0eac726983f8cdfb6bade20a2b5445559a962e0
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Hugo Brito