This commit fixes the documentation so that the API path to get LLDP
neighbors reflect the spelling used in the code. The path in the code
is lldp_neighbours, and in the documentation was lldp_neighbors.
Test plan
[PASS] API paths in documentation are shown as */lldp_neighbours/*
instead of */lldp_neighbors/*
Partial-Bug: #2054707
Change-Id: If1b1dc205b398cf050585c995bbc2ce985b29c40
Signed-off-by: Lucas Ratusznei Fonseca <lucas.ratuszneifonseca@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: I04a417a96daffaa5bb6570130545bc66527896d6
- 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
patch 5: Update to use 'Metal' instead of 'Bare Metal' per comments
Story:2007193
Task:38340
Change-Id: I22aa2f15850d4b5ecf01fd78c015b772b87a4932
Signed-off-by: Kristal Dale <kristal.dale@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)
Story: 2004737
Task: 28805
Change-Id: I388cc5d69db56e6e94bf034ece2478933c9d9c1e
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: Ib41f10ce72eb283d4edbeb1ecc0543403295d7bf
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
I added the api-ref-sysinv-v1-metal.rst file, which is content
for the API reference manual to the api-ref/source dir. This
represents the converted old-style files to the newer OpenStack
supported RST files.
I updated the index.rst file to include the new .rst file so that
the api-ref document can build.
Updated the actual output using Platform http://10.10.10.2:6385/v1
and querying.
Change-Id: I943dd136b2b083743e053db5070d4da7fbe78685
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>