diff --git a/.gitignore b/.gitignore index 84d2102df..f86567768 100644 --- a/.gitignore +++ b/.gitignore @@ -55,3 +55,7 @@ myapp.profile *.out.myapp AUTHORS ChangeLog + +# Editors +*~ +.*.swp diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100755 index 000000000..167f10c54 --- /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'Barbican' +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/index.rst b/doc/source/index.rst new file mode 100644 index 000000000..8760bedad --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,32 @@ +.. barbican 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. + +Welcome to Barbican's developer documentation! +======================================================== + +Barbican is an incubated OpenStack service that provides secure storage, +provisioning and management of secret data. This includes keying material such +as Symmetric Keys, Asymmetric Keys, Certificates and raw binary data. + +This document describes Barbican for contributors of the project, and assumes +that you are already familiar with Barbican from an end-user perspective. + +This documentation is generated by the Sphinx toolkit and lives in the source +tree. + +Getting Started +=============== +.. toctree:: + :maxdepth: 2 + + setup + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/setup.rst b/doc/source/setup.rst new file mode 100644 index 000000000..4f56b69e5 --- /dev/null +++ b/doc/source/setup.rst @@ -0,0 +1,7 @@ +Setting up a Barbican development environment +============================================ + +See the `Developer Guide`_ in CloudKeep/Barbican's GitHub wiki for instructions +on how to set up your workstation for Barbican development. + +.. _`Developer Guide`: https://github.com/cloudkeep/barbican/wiki/Developer-Guide diff --git a/test-requirements.txt b/test-requirements.txt index 00fbe1a54..28e510ee4 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -2,5 +2,9 @@ coverage>=3.6 discover hacking>=0.8.0,<0.9 mock>=1.0 -testrepository>=0.0.17 -testtools>=0.9.32,<0.9.35 +testrepository>=0.0.18 +testtools>=0.9.34 + +# Documentation build requirements +sphinx>=1.1.2,<1.2 +oslosphinx