diff options
author | Paul Belanger <pabelanger@redhat.com> | 2015-06-09 15:21:00 -0400 |
---|---|---|
committer | Paul Belanger <pabelanger@redhat.com> | 2015-06-11 11:10:47 -0400 |
commit | a4cf44a13a90469564f0df7519f4bfa5e6b19f05 (patch) | |
tree | c6c06a05f2cd1e7d0eb6a63db1a6b4b7d9961ea4 /pbr/tests/testpackage/doc | |
parent | dceb9e56dd6ef95e5a188aaee01a43602a569a2c (diff) | |
download | pbr-a4cf44a13a90469564f0df7519f4bfa5e6b19f05.tar.gz |
Add build_sphinx test coverage
Change-Id: Ic3baecf71410bfcc50233289aa74f5f1f84296af
Signed-off-by: Paul Belanger <pabelanger@redhat.com>
Diffstat (limited to 'pbr/tests/testpackage/doc')
-rwxr-xr-x | pbr/tests/testpackage/doc/source/conf.py | 74 | ||||
-rw-r--r-- | pbr/tests/testpackage/doc/source/index.rst | 23 | ||||
-rw-r--r-- | pbr/tests/testpackage/doc/source/installation.rst | 12 | ||||
-rw-r--r-- | pbr/tests/testpackage/doc/source/usage.rst | 7 |
4 files changed, 116 insertions, 0 deletions
diff --git a/pbr/tests/testpackage/doc/source/conf.py b/pbr/tests/testpackage/doc/source/conf.py new file mode 100755 index 0000000..7358510 --- /dev/null +++ b/pbr/tests/testpackage/doc/source/conf.py @@ -0,0 +1,74 @@ +# -*- 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', +] + +# 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'testpackage' +copyright = u'2013, 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/pbr/tests/testpackage/doc/source/index.rst b/pbr/tests/testpackage/doc/source/index.rst new file mode 100644 index 0000000..9ce317f --- /dev/null +++ b/pbr/tests/testpackage/doc/source/index.rst @@ -0,0 +1,23 @@ +.. testpackage 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 testpackage's documentation! +======================================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + installation + usage + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/pbr/tests/testpackage/doc/source/installation.rst b/pbr/tests/testpackage/doc/source/installation.rst new file mode 100644 index 0000000..65bca43 --- /dev/null +++ b/pbr/tests/testpackage/doc/source/installation.rst @@ -0,0 +1,12 @@ +============ +Installation +============ + +At the command line:: + + $ pip install testpackage + +Or, if you have virtualenvwrapper installed:: + + $ mkvirtualenv testpackage + $ pip install testpackage diff --git a/pbr/tests/testpackage/doc/source/usage.rst b/pbr/tests/testpackage/doc/source/usage.rst new file mode 100644 index 0000000..af97d79 --- /dev/null +++ b/pbr/tests/testpackage/doc/source/usage.rst @@ -0,0 +1,7 @@ +======== +Usage +======== + +To use testpackage in a project:: + + import testpackage |