exported from oslo-incubator by graduate.sh

7 files changed, 132 insertions, 0 deletions

diff --git a/doc/source/api.rst b/doc/source/api.rst
new file mode 100644
index 0000000..971225e
--- /dev/null
+++ b/doc/source/api.rst
@@ -0,0 +1,12 @@
+=====
+ API
+=====
+
+.. Use autodoc directives to describe the *public* modules and classes
+   in the library.
+
+   If the modules are completely unrelated, create an api subdirectory
+   and use a separate file for each (see oslo.utils).
+
+   If there is only one submodule, a single api.rst file like this
+   sufficient (see oslo.i18n).
diff --git a/doc/source/conf.py b/doc/source/conf.py
new file mode 100755
index 0000000..bf20de1
--- /dev/null
+++ b/doc/source/conf.py
@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+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
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'oslo.context'
+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
+
+# 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'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+#intersphinx_mapping = {'http://docs.python.org/': None}
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
new file mode 100644
index 0000000..2ca75d1
--- /dev/null
+++ b/doc/source/contributing.rst
@@ -0,0 +1,5 @@
+==============
+ Contributing
+==============
+
+.. include:: ../../CONTRIBUTING.rst
diff --git a/doc/source/history.rst b/doc/source/history.rst
new file mode 100644
index 0000000..69ed4fe
--- /dev/null
+++ b/doc/source/history.rst
@@ -0,0 +1 @@
+.. include:: ../../ChangeLog
diff --git a/doc/source/index.rst b/doc/source/index.rst
new file mode 100644
index 0000000..8216fb0
--- /dev/null
+++ b/doc/source/index.rst
@@ -0,0 +1,25 @@
+==============
+ oslo.context
+==============
+
+oslo.context library
+
+Contents
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   installation
+   api
+   usage
+   contributing
+   history
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
new file mode 100644
index 0000000..fa0c325
--- /dev/null
+++ b/doc/source/installation.rst
@@ -0,0 +1,7 @@
+==============
+ Installation
+==============
+
+At the command line::
+
+    $ pip install oslo.context
diff --git a/doc/source/usage.rst b/doc/source/usage.rst
new file mode 100644
index 0000000..1118e9a
--- /dev/null
+++ b/doc/source/usage.rst
@@ -0,0 +1,7 @@
+=======
+ Usage
+=======
+
+To use oslo.context in a project::
+
+    from oslo import context