diff options
Diffstat (limited to 'doc/source')
-rwxr-xr-x | doc/source/conf.py | 75 | ||||
-rw-r--r-- | doc/source/contributing.rst | 4 | ||||
-rw-r--r-- | doc/source/index.rst | 25 | ||||
-rw-r--r-- | doc/source/installation.rst | 12 | ||||
-rw-r--r-- | doc/source/readme.rst | 1 | ||||
-rw-r--r-- | doc/source/usage.rst | 7 |
6 files changed, 124 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100755 index 0000000..4753ad3 --- /dev/null +++ b/doc/source/conf.py | |||
@@ -0,0 +1,75 @@ | |||
1 | # -*- coding: utf-8 -*- | ||
2 | # Licensed under the Apache License, Version 2.0 (the "License"); | ||
3 | # you may not use this file except in compliance with the License. | ||
4 | # You may obtain a copy of the License at | ||
5 | # | ||
6 | # http://www.apache.org/licenses/LICENSE-2.0 | ||
7 | # | ||
8 | # Unless required by applicable law or agreed to in writing, software | ||
9 | # distributed under the License is distributed on an "AS IS" BASIS, | ||
10 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
11 | # implied. | ||
12 | # See the License for the specific language governing permissions and | ||
13 | # limitations under the License. | ||
14 | |||
15 | import os | ||
16 | import sys | ||
17 | |||
18 | sys.path.insert(0, os.path.abspath('../..')) | ||
19 | # -- General configuration ---------------------------------------------------- | ||
20 | |||
21 | # Add any Sphinx extension module names here, as strings. They can be | ||
22 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | ||
23 | extensions = [ | ||
24 | 'sphinx.ext.autodoc', | ||
25 | #'sphinx.ext.intersphinx', | ||
26 | 'oslosphinx' | ||
27 | ] | ||
28 | |||
29 | # autodoc generation is a bit aggressive and a nuisance when doing heavy | ||
30 | # text edit cycles. | ||
31 | # execute "export SPHINX_DEBUG=1" in your terminal to disable | ||
32 | |||
33 | # The suffix of source filenames. | ||
34 | source_suffix = '.rst' | ||
35 | |||
36 | # The master toctree document. | ||
37 | master_doc = 'index' | ||
38 | |||
39 | # General information about the project. | ||
40 | project = u'ttrun' | ||
41 | copyright = u'2016, OpenStack Foundation' | ||
42 | |||
43 | # If true, '()' will be appended to :func: etc. cross-reference text. | ||
44 | add_function_parentheses = True | ||
45 | |||
46 | # If true, the current module name will be prepended to all description | ||
47 | # unit titles (such as .. function::). | ||
48 | add_module_names = True | ||
49 | |||
50 | # The name of the Pygments (syntax highlighting) style to use. | ||
51 | pygments_style = 'sphinx' | ||
52 | |||
53 | # -- Options for HTML output -------------------------------------------------- | ||
54 | |||
55 | # The theme to use for HTML and HTML Help pages. Major themes that come with | ||
56 | # Sphinx are currently 'default' and 'sphinxdoc'. | ||
57 | # html_theme_path = ["."] | ||
58 | # html_theme = '_theme' | ||
59 | # html_static_path = ['static'] | ||
60 | |||
61 | # Output file base name for HTML help builder. | ||
62 | htmlhelp_basename = '%sdoc' % project | ||
63 | |||
64 | # Grouping the document tree into LaTeX files. List of tuples | ||
65 | # (source start file, target name, title, author, documentclass | ||
66 | # [howto/manual]). | ||
67 | latex_documents = [ | ||
68 | ('index', | ||
69 | '%s.tex' % project, | ||
70 | u'%s Documentation' % project, | ||
71 | u'OpenStack Foundation', 'manual'), | ||
72 | ] | ||
73 | |||
74 | # Example configuration for intersphinx: refer to the Python standard library. | ||
75 | #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..1728a61 --- /dev/null +++ b/doc/source/contributing.rst | |||
@@ -0,0 +1,4 @@ | |||
1 | ============ | ||
2 | Contributing | ||
3 | ============ | ||
4 | .. include:: ../../CONTRIBUTING.rst | ||
diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..0ea7d0f --- /dev/null +++ b/doc/source/index.rst | |||
@@ -0,0 +1,25 @@ | |||
1 | .. ttrun documentation master file, created by | ||
2 | sphinx-quickstart on Tue Jul 9 22:26:36 2013. | ||
3 | You can adapt this file completely to your liking, but it should at least | ||
4 | contain the root `toctree` directive. | ||
5 | |||
6 | Welcome to ttrun's documentation! | ||
7 | ======================================================== | ||
8 | |||
9 | Contents: | ||
10 | |||
11 | .. toctree:: | ||
12 | :maxdepth: 2 | ||
13 | |||
14 | readme | ||
15 | installation | ||
16 | usage | ||
17 | contributing | ||
18 | |||
19 | Indices and tables | ||
20 | ================== | ||
21 | |||
22 | * :ref:`genindex` | ||
23 | * :ref:`modindex` | ||
24 | * :ref:`search` | ||
25 | |||
diff --git a/doc/source/installation.rst b/doc/source/installation.rst new file mode 100644 index 0000000..1d502e5 --- /dev/null +++ b/doc/source/installation.rst | |||
@@ -0,0 +1,12 @@ | |||
1 | ============ | ||
2 | Installation | ||
3 | ============ | ||
4 | |||
5 | At the command line:: | ||
6 | |||
7 | $ pip install ttrun | ||
8 | |||
9 | Or, if you have virtualenvwrapper installed:: | ||
10 | |||
11 | $ mkvirtualenv ttrun | ||
12 | $ pip install ttrun | ||
diff --git a/doc/source/readme.rst b/doc/source/readme.rst new file mode 100644 index 0000000..a6210d3 --- /dev/null +++ b/doc/source/readme.rst | |||
@@ -0,0 +1 @@ | |||
.. include:: ../../README.rst | |||
diff --git a/doc/source/usage.rst b/doc/source/usage.rst new file mode 100644 index 0000000..b38e015 --- /dev/null +++ b/doc/source/usage.rst | |||
@@ -0,0 +1,7 @@ | |||
1 | ======== | ||
2 | Usage | ||
3 | ======== | ||
4 | |||
5 | To use ttrun in a project:: | ||
6 | |||
7 | import ttrun | ||