4 Commits

Author SHA1 Message Date
Andreas Jaeger
b8cfb53f19 Update docs building
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
2020-06-04 14:01:52 +02:00
Kristal Dale
841b900aad - 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:38353

Change-Id: I2364abf50b218acb8b58f83f8a09c4b553d2e469
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-21 16:41:40 -08:00
Dean Troyer
d220b08b34 Switch to new starlingxdocs theme
Change-Id: Id6bb154b509a5cb822cd1f32167f48ba7876645a
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-19 06:30:45 -05:00
Abraham Arce
ccd043a129 [Doc] OpenStack API Reference Guide Staging Repos
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>
2018-09-25 17:07:17 -07:00