clean up sphinx settings

Clean up the conf.py and several of the content pages, including
finishing configuring the theme.

Change-Id: I1f48cbcdd5efbf53ff86e6b8798a587a547c188f
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2018-05-08 10:47:39 -04:00
parent 765c02a15b
commit 429c50163e
5 changed files with 30 additions and 62 deletions

View File

@ -1,13 +1,8 @@
===============================
constellations
===============================
================
constellations
================
Reference configurations of OpenStack services
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/constellations
Features
--------
* TODO

View File

@ -13,19 +13,21 @@
# limitations under the License.
import datetime
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
# -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
'openstackdocstheme',
]
# openstackdocstheme settings
repository_name = 'openstack/constellations'
bug_project = '987'
version = ''
release = ''
# Optionally allow the use of sphinxcontrib.spelling to verify the
# spelling of the documents.
try:
@ -45,7 +47,6 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'constellations'
copyright = u'%s, OpenStack Foundation' % datetime.date.today().year
# If true, '()' will be appended to :func: etc. cross-reference text.
@ -65,16 +66,4 @@ pygments_style = 'sphinx'
# html_theme_path = ["."]
# html_theme = '_theme'
# html_static_path = ['static']
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index',
'%s.tex' % project,
u'%s Documentation' % project,
u'OpenStack Foundation', 'manual'),
]
html_theme = 'openstackdocs'

View File

@ -1,21 +1,21 @@
=============================================
Contributing to: constellations
=============================================
====================================
Contributing to this documentation
====================================
If you would like to contribute to the development of OpenStack, you must
follow the steps in this page:
http://docs.openstack.org/infra/manual/developers.html
http://docs.openstack.org/infra/manual/developers.html
If you already have a good understanding of how the system works and your
OpenStack accounts are set up, you can skip to the development workflow
section of this documentation to learn how changes to OpenStack should be
submitted for review via the Gerrit tool:
http://docs.openstack.org/infra/manual/developers.html#development-workflow
http://docs.openstack.org/infra/manual/developers.html#development-workflow
Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad, not GitHub:
Bugs should be filed on StoryBoard, not GitHub:
https://bugs.launchpad.net/constellations
https://storyboard.openstack.org/#!/project/987

View File

@ -1,25 +1,24 @@
.. constellations documentation master file, created by
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
================================================
Reference configurations of OpenStack services
================================================
constellations Design Specifications
==================================================
Constellations
==============
.. NOTE(dhellmann): Remove this line and uncomment the next to add content.
.. .. toctree::
.. :glob:
.. :maxdepth: 2
:glob:
:maxdepth: 1
*
constellations Repository Information
===================================================
Repository Information
======================
.. toctree::
:maxdepth: 2
:maxdepth: 1
README <readme>
contributing
@ -27,6 +26,4 @@ Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -1,13 +0,0 @@
===============================
constellations
===============================
Reference configurations of OpenStack services
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/constellations
Features
--------
* TODO