summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavanum Srinivas <dims@linux.vnet.ibm.com>2014-08-11 15:12:26 -0400
committerDavanum Srinivas (dims) <davanum@gmail.com>2014-08-21 11:47:00 +0000
commit94bff36bdf1ccf186c3accd88666b8b53c4c7c3c (patch)
tree596607eacd87dcc1a65ba40b9d1d7de05bf2a20d
parentd2d8f253abb2e1f11c87828f571190c0cbc791ae (diff)
downloadoslo-serialization-94bff36bdf1ccf186c3accd88666b8b53c4c7c3c.tar.gz
Fix docs build to run properly
Change-Id: I7f684bc48c5ce913a5799f78c80bda459cf35f65
-rw-r--r--CONTRIBUTING.rst2
-rw-r--r--doc/source/contributing.rst6
-rw-r--r--doc/source/readme.rst2
-rw-r--r--setup.cfg5
-rw-r--r--test-requirements.txt4
-rw-r--r--tox.ini5
6 files changed, 19 insertions, 5 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index a9d6a7d..88b16aa 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -14,4 +14,4 @@ Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad, not GitHub:
- https://bugs.launchpad.net/oslo.serialization \ No newline at end of file
+ https://bugs.launchpad.net/oslo
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
index 8cb3146..2ca75d1 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributing.rst
@@ -1 +1,5 @@
-.. include:: ../../CONTRIBUTING.rst \ No newline at end of file
+==============
+ Contributing
+==============
+
+.. include:: ../../CONTRIBUTING.rst
diff --git a/doc/source/readme.rst b/doc/source/readme.rst
index 6b2b3ec..a6210d3 100644
--- a/doc/source/readme.rst
+++ b/doc/source/readme.rst
@@ -1 +1 @@
-.. include:: ../README.rst \ No newline at end of file
+.. include:: ../../README.rst
diff --git a/setup.cfg b/setup.cfg
index 7c2b0f0..03a0918 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -26,6 +26,9 @@ packages =
namespace_packages =
oslo
+[pbr]
+warnerrors = true
+
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
@@ -46,4 +49,4 @@ input_file = oslo.serialization/locale/oslo.serialization.pot
[extract_messages]
keywords = _ gettext ngettext l_ lazy_gettext
mapping_file = babel.cfg
-output_file = oslo.serialization/locale/oslo.serialization.pot \ No newline at end of file
+output_file = oslo.serialization/locale/oslo.serialization.pot
diff --git a/test-requirements.txt b/test-requirements.txt
index 7f0ac98..a3504ed 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -1,7 +1,11 @@
hacking>=0.5.6,<0.8
mock>=1.0
netaddr
+
+# this is required for the docs build jobs
+sphinx>=1.1.2,!=1.2.0,<1.3
oslosphinx
+
oslotest
simplejson
oslo.i18n>=0.2.0
diff --git a/tox.ini b/tox.ini
index 95d4e1f..c5bd950 100644
--- a/tox.ini
+++ b/tox.ini
@@ -22,6 +22,9 @@ commands = flake8
[testenv:venv]
commands = {posargs}
+[testenv:docs]
+commands = python setup.py build_sphinx
+
[testenv:cover]
commands = python setup.py testr --coverage --testr-args='{posargs}'
@@ -32,4 +35,4 @@ commands = python setup.py testr --coverage --testr-args='{posargs}'
show-source = True
ignore = E123,E125,H803
builtins = _
-exclude=.venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build \ No newline at end of file
+exclude=.venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build