diff options
| -rw-r--r-- | CONTRIBUTING.rst | 17 | ||||
| -rw-r--r-- | README.rst | 7 | ||||
| -rwxr-xr-x | doc/source/conf.py | 76 | ||||
| -rw-r--r-- | doc/source/contributing.rst | 4 | ||||
| -rw-r--r-- | doc/source/index.rst | 24 | ||||
| -rw-r--r-- | doc/source/installation.rst | 12 | ||||
| -rw-r--r-- | doc/source/readme.rst | 1 | ||||
| -rw-r--r-- | doc/source/usage.rst | 7 | ||||
| -rw-r--r-- | test-requirements.txt | 4 | ||||
| -rw-r--r-- | tox.ini | 16 |
10 files changed, 157 insertions, 11 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..63f6979 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,17 @@ +If you would like to contribute to the development of OpenStack, +you must follow the steps in the "If you're a developer, start here" +section of this page: + + http://wiki.openstack.org/HowToContribute + +Once those steps have been completed, changes to OpenStack +should be submitted for review via the Gerrit tool, following +the workflow documented at: + + http://wiki.openstack.org/GerritWorkflow + +Pull requests submitted through GitHub will be ignored. + +Bugs should be filed on Launchpad, not GitHub: + + https://bugs.launchpad.net/python-barbicanclient
\ No newline at end of file @@ -49,7 +49,8 @@ with keystone authentication: >>> secret.store() u'http://localhost:9311/v1/secrets/85b220fd-f414-483f-94e4-2f422480f655' >>> # The URI returned by store() uniquely identifies your secret in the Barbican service. - >>> # After a secret is stored, the URI is also avaiable by accessing the secret_ref attribute. + >>> # After a secret is stored, the URI is also available by accessing + >>> # the secret_ref attribute. >>> print(secret.secret_ref) http://localhost:9311/v1/secrets/091adb32-4050-4980-8558-90833c531413 >>> # When we need to retrieve our secret at a later time, we can use the secret_ref @@ -92,11 +93,12 @@ The command line client is self-documenting. Use the --help flag to access the u --log-file LOG_FILE Specify a file to log output. Disabled by default. -q, --quiet suppress output except warnings and errors -h, --help show this help message and exit - --debug show tracebacks on errors + --debug show trace backs on errors --no-auth, -N Do not use authentication. --os-identity-api-version <identity-api-version> Specify Identity API version to use. Defaults to env[OS_IDENTITY_API_VERSION] or 3.0. + --os-auth-url <auth-url>, -A <auth-url> Defaults to env[OS_AUTH_URL]. --os-username <auth-user-name>, -U <auth-user-name> @@ -156,4 +158,3 @@ The command line client is self-documenting. Use the --help flag to access the u secret get Retrieve a secret by providing its URI. secret list List secrets. secret store Store a secret in Barbican. - diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100755 index 0000000..dbad445 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,76 @@ +# -*- 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'python-barbicanclient' +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'] +html_theme_options = {'incubating': True} + +# 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..ed77c12 --- /dev/null +++ b/doc/source/contributing.rst @@ -0,0 +1,4 @@ +============ +Contributing +============ +.. include:: ../../CONTRIBUTING.rst
\ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..f45fef6 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,24 @@ +.. python-barbicanclient 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 python-barbicanclient's documentation! +======================================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + readme + installation + usage + contributing + +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..7b910d2 --- /dev/null +++ b/doc/source/installation.rst @@ -0,0 +1,12 @@ +============ +Installation +============ + +At the command line:: + + $ pip install python-barbicanclient + +Or, if you have virtualenvwrapper installed:: + + $ mkvirtualenv python-barbicanclient + $ pip install python-barbicanclient
\ No newline at end of file diff --git a/doc/source/readme.rst b/doc/source/readme.rst new file mode 100644 index 0000000..38ba804 --- /dev/null +++ b/doc/source/readme.rst @@ -0,0 +1 @@ +.. include:: ../../README.rst
\ No newline at end of file diff --git a/doc/source/usage.rst b/doc/source/usage.rst new file mode 100644 index 0000000..2d062b2 --- /dev/null +++ b/doc/source/usage.rst @@ -0,0 +1,7 @@ +======== +Usage +======== + +To use python-barbicanclient in a project:: + + import barbicanclient
\ No newline at end of file diff --git a/test-requirements.txt b/test-requirements.txt index 170f7e0..baa7a28 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,3 +5,7 @@ httpretty>=0.8.0 mock>=1.0.1 testrepository>=0.0.17 testtools>=0.9.32,<0.9.35 + +# Documentation build requirements +sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 +oslosphinx>=2.2.0 # Apache-2.0 @@ -1,16 +1,13 @@ -# Tox (http://tox.testrun.org/) is a tool for running tests -# in multiple virtualenvs. This configuration file will run the -# test suite on all supported python versions. To use it, "pip install tox" -# and then run "tox" from this directory. - [tox] minversion = 1.6 -envlist = py26, py27, py33,py34, pypy, pep8 +envlist = py33,py34,py26,py27,pypy,pep8 skipsdist = True [testenv] usedevelop = True install_command = pip install -U {opts} {packages} +setenv = + VIRTUAL_ENV={envdir} deps = -r{toxinidir}/requirements.txt -r{toxinidir}/test-requirements.txt commands = @@ -24,10 +21,13 @@ commands = {toxinidir}/tools/hacking.sh {posargs} [testenv:venv] commands = {posargs} +[testenv:docs] +commands = python setup.py build_sphinx + [tox:jenkins] downloadcache = ~/cache/pip [flake8] -ignore = F,H show-source = True -exclude = .venv,.tox,dist,doc,*egg +ignore = F,H +exclude=.venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build |