With sphinx version update, it is raised a warning (treated as
error) with the 'language = None' configuration. The default value is
'language = en' which has the same behavior.
Test plan
PASS: Run tox and check it ends successfully.
Closes-bug: 2033412
Related-Bug: #1976377
Change-Id: Ie003c0a02fcfc6f237ae5b3efb259de6748077ad
Signed-off-by: Agustin Carranza <agustin.carranza@windriver.com>
In the current implementation "Fault" is responsible
for the generation and dispatch of traps.
This logic is removed from it, leaving only the
responsibility of sending the metadata of a trap
to a service dedicated to generating and sending them.
The fm.conf file will contain the IP and port values
of the service.
Story: 2008132
Task: 40867
Depends-On: https://review.opendev.org/761217
Change-Id: I575dfa2329f11821404ca4cb1d539e5189444b4e
Signed-off-by: Pablo Bovina <pablo.bovina@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: I0f1672c32d14ce7a096bf8c68741208b6fa2434c
- 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:38337
Change-Id: I03de3548572d3b5f2f68cfa6105ed876c973b5e6
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: I4b74c76007faf491d9c48a42c49702f388c87c98
Partial-Bug: #1835207
Signed-off-by: junboli <junbo85.li@gmail.com>
This commit documents an overview in order to give a general idea
about what is Fault Management service and what is the role in
StarlingX project.
Story: 2005863
Task: 33669
Change-Id: Id58385cabc9c656aa03132a42f39d9663a6be08e
Signed-off-by: Mario Alfredo Carrillo Arevalo <mario.alfredo.c.arevalo@intel.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
releasenotes index.rst:
1. Standardize page title reST markup
2. Remove search (make consistent with other openstack release note pages)
Change-Id: I57d05e7a37997fa6941852d420cfed7e6c7c5ad6
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
Change-Id: Iece880f25e33f0c18a512904b7839b24a0cacbac
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Also set the theme to alabaster until starlingxdocs is ready
Change-Id: I8881381821ca3497f3451c15043e1469d3366a52
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
Baseline changes to comply with OpenStack API documentation
from OpenStack Documentation Contributor Guide [0]:
- [1] How to document your OpenStack API service
- Adding SPDX-License-Identifier: Apache-2.0
[0] https://docs.openstack.org/doc-contrib-guide
[1] https://docs.openstack.org/doc-contrib-guide/api-guides.html
Story: 2002712
Task: 26697
Change-Id: I1816a0e6bea3f577689804362da39a617368e7b7
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.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.
* Adding SPDX-License-Identifier: Apache-2.0
[0] https://docs.openstack.org/reno/latest/
Story: 2003101
Task: 26696
Change-Id: I03cd9d9fe6e2d0d4ae1a02210f74a456a2a2839c
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Agustin Carranza