Several reorgs:
* setup.cfg/setup.py must be in top-level dir so that siblings
(installing for example openstackdocstheme from source instead of
pip) works.
* Update openstackdocstheme version (see below)
* Remove unused entries from setup.cfg
* Remove py27 code from setup.py
* Update tox.ini for a py3 only world and cleanup
Switch to openstackdocstheme 2.2.1 version. Using
this version 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: I27039f9dc52c3e6c9e667b5699172d0f834e8f6b
- 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:38353
Change-Id: I2364abf50b218acb8b58f83f8a09c4b553d2e469
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
API Reference content has been added for stx-update:
- Add link and pages for API Ref and main page.
The project-specific docs are published independently so we need
to maintain the links into those subtrees, for the api-ref (/api-ref/stx-*).
This change was introduced and then reverted due to this abandoned
commit:
https://review.openstack.org/#/c/605278/
Reason was a confussion during the split of old API into the new
API scheme.
Depends-On: https://review.openstack.org/#/c/634994/
Change-Id: I3a4bd5e98cf7077cf4c3abe037d1a0f6d8c69fcf
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Updated three "index.html" files to remove the "Software Updates"
link from two API ref landing pages and one general StarlingX
doc landing page. The link appeared in three areas:
The "Software Updates" page no longer exists.
Change-Id: Ib54057ad840b2fd0029ef5da03addaf621d0c731
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Installation guides should list the XML server definitions for each
configuration:
- Controller-N
- Compute-N
- Storage-N
Additionally, where it applies:
- Add method to power up virtual servers.
- Reword system configuration section.
- Use host-if-modify syntax valid for current release.
Minor changes:
- Remove DRAFT from the top of Release Notes Contribute Guide.
- Fix api-ref broken links
Change-Id: I2aed6a2dadd58bf5f701f15b94257afd5d79e6de
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
The project-specific docs are published independently so we need
to maintain the links into those subtrees (/stx-*), also
for the api-ref (/api-ref/stx-*) and releasenotes (/releasenotes/stx-*).
Also add docs env to the default list in tox.ini.
Change-Id: If68e6c984d684af05124b3252a8ff3c4b44b6d82
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
* Add pointers in the main doc to api-ref and releasenotes pages
* Add publish-stx-api-ref job
* Add search at bottom of api-ref and relnotes pages to trigger the jobs
* Add openstackdocstheme installation into requirements file
Change-Id: I11db7e584f3e16f1fd0517a5c0059bdc2d448399
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
I added the api-ref-blockstorage-v2-cgcs-ext.rst,
api-ref-compute-v2-cgcs-ext.rst, api-ref-image-v2-cgcs-ext.rst,
and api-ref-networking-v2-cgcs-ext.rst files, which are content
for the remaining 4 API reference manuals 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.
Change-Id: I4c3e89d38b1e6afd52d0307fb95be8c0d974ff45
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Baseline changes to comply with OpenStack API documentation
from OpenStack Documentation Contributor Guide [0] for
the following StarlingX staging repos:
- stx-python-cinderclient
- stx-nova
- stx-glance
- stx-neutron
Changes:
- [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: 26728
Change-Id: Ie8a142360b7c57d7ec477559757aa8295feb09ff
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>