summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2014-09-02 17:07:02 +0000
committerGerrit Code Review <review@openstack.org>2014-09-02 17:07:02 +0000
commit720af896c8d6f8eabe2a52ecb839d28488441d2c (patch)
treee32118508d29adc160999226f39c7b09ca3053ae
parentcbf995ef87278e00f22b30445622d1033017bee3 (diff)
parentf2f0960b150de0299c79fe0ef489dd0832db3244 (diff)
downloadoslo-db-720af896c8d6f8eabe2a52ecb839d28488441d2c.tar.gz
Merge "Add doc8 to tox environment docs"
-rw-r--r--HACKING.rst6
-rw-r--r--doc/source/usage.rst6
-rw-r--r--test-requirements.txt1
-rw-r--r--tox.ini1
4 files changed, 8 insertions, 6 deletions
diff --git a/HACKING.rst b/HACKING.rst
index 8f0f190..cb07476 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -1,4 +1,4 @@
- Style Commandments
-===============================================
+Style Commandments
+==================
-Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/ \ No newline at end of file
+Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/
diff --git a/doc/source/usage.rst b/doc/source/usage.rst
index 0e5a2f2..0591ebe 100644
--- a/doc/source/usage.rst
+++ b/doc/source/usage.rst
@@ -5,7 +5,7 @@ Usage
To use oslo.db in a project::
* Session Handling
-
+
.. code:: python
from oslo.config import cfg
@@ -32,7 +32,7 @@ To use oslo.db in a project::
.. code:: python
- from oslo.db import models
+ from oslo.db import models
class ProjectSomething(models.TimestampMixin,
@@ -41,7 +41,7 @@ To use oslo.db in a project::
...
-* DB API backend support
+* DB API backend support
.. code:: python
diff --git a/test-requirements.txt b/test-requirements.txt
index 666e315..f438aca 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -2,6 +2,7 @@ hacking>=0.9.2,<0.10
coverage>=3.6
discover
+doc8
fixtures>=0.3.14
MySQL-python
psycopg2
diff --git a/tox.ini b/tox.ini
index 2ef33b1..36653f7 100644
--- a/tox.ini
+++ b/tox.ini
@@ -35,6 +35,7 @@ commands = python setup.py testr --coverage --testr-args='{posargs}'
[testenv:docs]
commands =
+ doc8 -e .rst CONTRIBUTING.rst HACKING.rst README.rst doc/source
python setup.py build_sphinx
[flake8]