From 37b90eda3e19102154ea4c3c0a4b0b84b1d9e6c7 Mon Sep 17 00:00:00 2001 From: Yuriy Taraday Date: Sat, 16 Aug 2014 00:15:34 +0400 Subject: [PATCH] Fix docs generation Also add docs environment to tox.ini to simplify local docs generation Change-Id: Ie0444264e4e02d206ded2c7568d58a26cfec3ae2 --- CONTRIBUTING.rst | 2 +- doc/source/contributing.rst | 6 +++++- doc/source/readme.rst | 2 +- test-requirements.txt | 5 ++++- tox.ini | 3 +++ 5 files changed, 14 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b2d63d2..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.concurrency \ 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/test-requirements.txt b/test-requirements.txt index ad615b9..95ce56d 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,3 +1,6 @@ hacking>=0.9.1,<0.10 -oslosphinx oslotest + +# These are needed for docs generation +oslosphinx +sphinx>=1.1.2,!=1.2.0,<1.3 diff --git a/tox.ini b/tox.ini index c114b08..329d601 100644 --- a/tox.ini +++ b/tox.ini @@ -29,6 +29,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}'