summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoshua Hesketh <josh@nitrotech.org>2013-11-18 13:06:20 +1100
committerJoshua Hesketh <josh@nitrotech.org>2013-11-21 10:31:33 +1100
commit3b7765de0d3df64be7607b4bec90af7ca7d0ad2f (patch)
tree2eda2b7114eed493d08d05de38fda000b75aa8c4
parente8a5b83528328103f23b0205da211a4ab4f1dd9b (diff)
downloadturbo-hipster-3b7765de0d3df64be7607b4bec90af7ca7d0ad2f.tar.gz
Add .gitreview file and fix documentation build
Change-Id: Ic95b7a2c04e0578f89d76bd77ca34301776658c8
-rw-r--r--.gitreview4
-rw-r--r--doc/source/conf.py4
-rw-r--r--doc/source/configuration.rst7
-rw-r--r--doc/source/installation.rst15
-rw-r--r--doc/source/running.rst7
-rw-r--r--tox.ini5
6 files changed, 34 insertions, 8 deletions
diff --git a/.gitreview b/.gitreview
new file mode 100644
index 0000000..bb94be1
--- /dev/null
+++ b/.gitreview
@@ -0,0 +1,4 @@
+[gerrit]
+host=review.openstack.org
+port=29418
+project=stackforge/turbo-hipster.git
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 8158f9c..61db50b 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -25,7 +25,7 @@ import sys, os
# 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.graphviz', 'sphinxcontrib.programoutput']
+extensions = ['sphinx.ext.graphviz']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -120,7 +120,7 @@ html_theme = 'default'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
new file mode 100644
index 0000000..a8bf44a
--- /dev/null
+++ b/doc/source/configuration.rst
@@ -0,0 +1,7 @@
+:title: Configuration
+
+
+Configuration
+=============
+
+todo... \ No newline at end of file
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index 106f4f4..9916eb7 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -34,7 +34,7 @@ Edit config
-----------
Turbo-hipsters configuration is currently stored in json format.
-Modify the config.json appropriately:
+Modify the config.json appropriately::
**zuul_server**
A dictionary containing details about how to communicate
@@ -122,9 +122,18 @@ turbo hipster can be ran by executing::
./turbo-hipster/worker_server.py
-and optionally takes the following parameters:
+and optionally takes the following parameters::
- .. program-output:: ../../turbo_hipster/worker_server.py --help
+ ./turbo_hipster/worker_server.py --help
+ usage: worker_server.py [-h] [-c CONFIG] [-b] [-p PIDFILE]
+
+ optional arguments:
+ -h, --help show this help message and exit
+ -c CONFIG, --config CONFIG
+ Path to json config file.
+ -b, --background Run as a daemon in the background.
+ -p PIDFILE, --pidfile PIDFILE
+ PID file to lock during daemonization.
By default turbo-hipster will look for
*/etc/turbo-hipster/config.json*
diff --git a/doc/source/running.rst b/doc/source/running.rst
new file mode 100644
index 0000000..b0903db
--- /dev/null
+++ b/doc/source/running.rst
@@ -0,0 +1,7 @@
+:title: Running
+
+
+Running
+=======
+
+todo... \ No newline at end of file
diff --git a/tox.ini b/tox.ini
index e6487bc..f0e38f0 100644
--- a/tox.ini
+++ b/tox.ini
@@ -7,11 +7,12 @@
envlist = pep8, pyflakes, py27
[testenv]
-sitepackages = True
setenv = VIRTUAL_ENV={envdir}
LANG=en_US.UTF-8
LANGUAGE=en_US:en
LC_ALL=C
+usedevelop = True
+install_command = pip install {opts} {packages}
deps = -r{toxinidir}/requirements.txt
-r{toxinidir}/test-requirements.txt
commands =
@@ -28,8 +29,6 @@ commands =
python setup.py testr --coverage
[testenv:pyflakes]
-deps = pyflakes
- -r{toxinidir}/requirements.txt
commands = pyflakes turbo_hipster setup.py
[testenv:venv]