5 Commits

Author SHA1 Message Date
Kristal Dale
37240fa085 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)

Change-Id: Ia12c5b865f3e4c973a7f403bbf787e7c91bf34a3
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-12-27 17:10:05 -08:00
Abraham Arce
cdcdd5ebb3 [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes
- API Reference

Add zuul check and gate job:

- build-openstack-api-ref

Change-Id: If47613fb6afa4e25b62360a4e3441a93296f4570
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:37:37 +00:00
Dean Troyer
bd7bd5cac1 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: If82fe40b570c43c4ac7b25e5bff5d3d72484677f
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-11 08:32:41 -05:00
Dean Troyer
c89589d31c Add publish job for docs
Also set the theme to alabaster until starlingxdocs is ready

Change-Id: Iccf80cf54075925752a3c3773ba7ccba0c47aed3
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-06 14:34:47 -05:00
Abraham Arce
f71ded2eba [Doc] Building docs following Docs Contrib Guide
Baseline changes to comply with OpenStack Documentation
Contributor Guide [0] starting with the following sections:

- Project guide setup
  - [1] sphinx-quickstart
  - [2] doc/source/ layout
- Building documentation
  - [3] tox -e docs
- Using documentation tools
  - [4] openstackdocstheme
- Use build-openstack-docs-pti job template for docs
- Change to SPDX-License-Identifier: Apache-2.0

[0] https://docs.openstack.org/doc-contrib-guide
[1] http://www.sphinx-doc.org/en/master/usage/quickstart.html
[2] https://docs.openstack.org/doc-contrib-guide/project-guides.html
[3] https://docs.openstack.org/doc-contrib-guide/docs-builds.html
[4] https://docs.openstack.org/openstackdocstheme/

Story: 2002708
Task: 26661

Story: 2002813
Task: 26662

Change-Id: Ib69552d026042572469e1ce4d97e6d42ac1dd49b
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 14:00:54 -07:00