diff options
author | Monty Taylor <mordred@inaugust.com> | 2012-07-02 17:19:06 -0400 |
---|---|---|
committer | Monty Taylor <mordred@inaugust.com> | 2012-07-02 17:19:06 -0400 |
commit | 8a967b16dc2ffd60bc19bee09f45e665ddcc9a81 (patch) | |
tree | 3cf0ffafd793a4562f233b8765eefee90412d5c6 /doc | |
parent | 506486550480fb222a92447e1e8baca855d126aa (diff) | |
download | oslo-8a967b16dc2ffd60bc19bee09f45e665ddcc9a81.tar.gz oslo-8a967b16dc2ffd60bc19bee09f45e665ddcc9a81.tar.xz oslo-8a967b16dc2ffd60bc19bee09f45e665ddcc9a81.zip |
Fix up openstack-common build.
Ironically enough, even though the code to manage this is in
openstack-common, openstack-common wasn't using it. This patch fixes doc
generation, as well as setuptools-git integration and versioning.
Change-Id: Ifb74ad539832d8cec4a536a96221eea8fb7527d2
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/conf.py | 60 | ||||
-rw-r--r-- | doc/source/index.rst | 17 |
2 files changed, 77 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..5849d98 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,60 @@ +# -*- coding: utf-8 -*- +# + +import sys, os + +project = 'openstack-common' + +# -- 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', 'sphinx.ext.intersphinx'] + +# autodoc generation is a bit aggressive and a nuisance when doing heavy +# text edit cycles. +# execute "export SPHINX_DEBUG=1" in your terminal to disable + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +copyright = u'OpenStack LLC' + +# If true, '()' will be appended to :func: etc. cross-reference text. +add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +add_module_names = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +html_theme = 'nature' + +# 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 LLC', 'manual'), +] + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..5e25c9b --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,17 @@ +OpenStack Common Code +===================== + +Code shared for common tasks across OpenStack. Contents: + +.. toctree:: + :maxdepth: 1 + + api/autoindex + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + |