diff options
author | Flavio Percoco <flaper87@gmail.com> | 2014-07-17 09:48:37 +0200 |
---|---|---|
committer | Flavio Percoco <flaper87@gmail.com> | 2014-07-17 11:53:18 +0200 |
commit | 2450528776035950898607dc0436da0515934244 (patch) | |
tree | 63dbe54fc4d638ddac09ce2be9fa78c2e4634bab /doc | |
parent | 80af4f414ab236daf7aa04519233c71cad7cf623 (diff) | |
download | glance_store-2450528776035950898607dc0436da0515934244.tar.gz |
Add .gitreview to the repo
This patch also removes `swift` related code until we port it.
Change-Id: I5c78af7334cb39e6d32afe7ca342f91c5521d30b
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/conf.py | 65 | ||||
-rw-r--r-- | doc/source/index.rst | 29 |
2 files changed, 94 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..125e241 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,65 @@ +# -*- coding: utf-8 -*- + +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', 'sphinx.ext.intersphinx', 'oslosphinx'] + +# 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 = [] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'glance.store' +copyright = u'2014, OpenStack Foundation' + +# 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_path = ["."] +# html_theme = '_theme' +html_static_path = ['static'] + +# Output file base name for HTML help builder. +htmlhelp_basename = '%sdoc' % project + +git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1" +html_last_updated_fmt = os.popen(git_cmd).read() + +# 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, + '%s Documentation' % project, + 'OpenStack Foundation', '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..11a5044 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,29 @@ +glance.store +============ + +The glance.store library supports the creation, deletion and gather of data +assets from/to a set of several, different, storage technologies + +Contents +======== + +.. toctree:: + :maxdepth: 1 + +Release Notes +============= + +0.0.1a1 +------- + +* Initial release of glance.store_. + +.. _glance.store: https://wiki.openstack.org/wiki/Glance/Store + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + |