starlingx/ansible-playbooks
Code Issues Proposed changes

[Doc] Building docs following Docs Contrib Guide

Browse Source 
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: 26510

Story: 2002813
Task: 26509

Change-Id: I30a92b228540eebd0f991e0c90675bc12d925894
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
This commit is contained in:
Abraham Arce
2018-09-17 08:32:51 -05:00
committed by Dean Troyer
parent 94771bdd54
commit 2d3a78d201
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@@ -21,3 +21,6 @@ develop-eggs
dist
eggs
sdist
# Sphinx documentation
doc/build/