Add common fixes for docs generation to template

Change-Id: Ieea0dc7ed7218e9bf5626e174e6184901efd9761
2014-08-16 01:30:16 +04:00 · 2014-08-16 01:30:16 +04:00 · 7f5f759f19
parent 475d60ee5e
commit 7f5f759f19
5 changed files with 13 additions and 3 deletions
--- a/oslo.{{cookiecutter.module_name}}/CONTRIBUTING.rst
+++ b/oslo.{{cookiecutter.module_name}}/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.{{ cookiecutter.module_name }}
+   https://bugs.launchpad.net/oslo
--- a/oslo.{{cookiecutter.module_name}}/doc/source/contributing.rst
+++ b/oslo.{{cookiecutter.module_name}}/doc/source/contributing.rst
@ -1 +1,5 @@
+==============
+ Contributing
+==============
+
 .. include:: ../../CONTRIBUTING.rst
--- a/oslo.{{cookiecutter.module_name}}/doc/source/readme.rst
+++ b/oslo.{{cookiecutter.module_name}}/doc/source/readme.rst
@ -1 +1 @@
-.. include:: ../README.rst
+.. include:: ../../README.rst
--- a/oslo.{{cookiecutter.module_name}}/test-requirements.txt
+++ b/oslo.{{cookiecutter.module_name}}/test-requirements.txt
@ -1,3 +1,6 @@
 hacking>=0.5.6,<0.8
-oslosphinx
 oslotest
+
+# These are needed for docs generation
+oslosphinx
+sphinx>=1.1.2,!=1.2.0,<1.3
--- a/oslo.{{cookiecutter.module_name}}/tox.ini
+++ b/oslo.{{cookiecutter.module_name}}/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}'