6 Commits

Author SHA1 Message Date
Kristal Dale
95d66cbd26 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)

releasenotes index.rst:
1. Standardize page title reST markup
2. Remove search (make consistent with other openstack release note pages)

Change-Id: I42e5b160336baf8498a83a5414a6e353cc529c5c
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-12-27 17:06:20 -08:00
Abraham Arce
6a0712ef9b [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes

Change-Id: Id56abf7f2fa506e6081e973e26fcf14d456b872f
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:36:35 +00:00
Dean Troyer
c7dfc772fa Add relnotes publish job
* Add pointers in the main doc to releasenotes pages
* Add publish-stx-releasenotes job
* Add search at bottom of relnotes page to trigger the job

Change-Id: I3ba4672681bdcc1810e10c534cfa0e49b4d82a2c
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-12 15:07:01 -05:00
Dean Troyer
35813762a7 Add publish job for docs
Also set the theme to alabaster until starlingxdocs is ready

Change-Id: Idcfe4244f6d43380c8cee87d165ca2786f3e1767
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-06 14:19:53 -05:00
Abraham Arce
3405723c77 [Doc] SPDX License Identifier
- Change to SPDX-License-Identifier: Apache-2.0

Change-Id: Ibaf7c805b7aea6f8793f9d600ae263c2e63cd8da
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 12:39:33 -05:00
Abraham Arce
f00b501641 [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

[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: 26718

Story: 2002813
Task: 24450

Change-Id: Id66fed45d16cdcad13988cd04f9c783398bfa781
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 04:30:20 -05:00