Commit Graph

10 Commits

Author SHA1 Message Date
Lucas Ratusznei Fonseca 33a4be37bc Fix reference to LLDP neighbors API path in the documentation
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>
2024-02-22 16:32:47 -03:00
Andreas Jaeger 0ea80db1ea Switch to newer openstackdocstheme and reno versions
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
2020-06-04 14:32:46 +02:00
Kristal Dale d75d427c11 Update landing pages for docs, api-ref, and release notes:
- 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>
2020-02-07 12:24:12 -08:00
Kristal Dale 3522ead301 Clean up and standardize landing pages
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>
2019-01-09 09:34:38 -08:00
Abraham Arce a526093ba8 [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes
- API Reference

Change-Id: I5a53eecaf97e835e85ea4d5a7fae2bc3ca3d45a8
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:37:08 +00:00
Dean Troyer 5558276784 Add api-ref and relnotes publish jobs
* 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>
2018-10-11 08:21:53 -05:00
Zuul 2ebe8c2e8e Merge "[Doc] SPDX License Identifier" 2018-10-09 15:17:34 +00:00
Scott Rifenbark 90252d2421 stx-metal: API ref doc content added.
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>
2018-09-28 17:33:34 +00:00
Abraham Arce d948fdc228 [Doc] SPDX License Identifier
- Change to SPDX-License-Identifier: Apache-2.0

Change-Id: Ie98277f4b8fca7084ff8d3f9622ced048a5d5f9c
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 09:39:07 -05:00
Abraham Arce 0162fa2526 [Doc] OpenStack API Reference Guide
Baseline changes to comply with OpenStack API documentation
from OpenStack Documentation Contributor Guide [0]:

- [1] How to document your OpenStack API service

[0] https://docs.openstack.org/doc-contrib-guide
[1] https://docs.openstack.org/doc-contrib-guide/api-guides.html

Story: 2002712
Task: 24451

Change-Id: I91f7640583081c83d3d43786e979ccfb5bee0490
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-05 19:59:26 -05:00