From 83b5d0fb1d45c055c1929a3016e4719484d48ee8 Mon Sep 17 00:00:00 2001 From: Mathew Odden Date: Tue, 20 May 2014 17:35:10 -0500 Subject: [PATCH] Fix documentation template issues This is a roll up of some of the fixes in bash8 that were needed after doing a cookiecut to create the project. Update to use oslosphinx instead of oslo.sphinx, fix the reference to the README.rst file, and add a header to the contributing doc page, since the default file doesn't come with one. Change-Id: Ic3033b7710e9c24ed044d322d08e1eb95e5dc760 --- {{cookiecutter.repo_name}}/doc/source/conf.py | 2 +- {{cookiecutter.repo_name}}/doc/source/contributing.rst | 3 +++ {{cookiecutter.repo_name}}/doc/source/readme.rst | 2 +- {{cookiecutter.repo_name}}/test-requirements.txt | 2 +- 4 files changed, 6 insertions(+), 3 deletions(-) diff --git a/{{cookiecutter.repo_name}}/doc/source/conf.py b/{{cookiecutter.repo_name}}/doc/source/conf.py index aa62045..95300f0 100755 --- a/{{cookiecutter.repo_name}}/doc/source/conf.py +++ b/{{cookiecutter.repo_name}}/doc/source/conf.py @@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslo.sphinx' + 'oslosphinx' ] # autodoc generation is a bit aggressive and a nuisance when doing heavy diff --git a/{{cookiecutter.repo_name}}/doc/source/contributing.rst b/{{cookiecutter.repo_name}}/doc/source/contributing.rst index ac7b6bc..1728a61 100644 --- a/{{cookiecutter.repo_name}}/doc/source/contributing.rst +++ b/{{cookiecutter.repo_name}}/doc/source/contributing.rst @@ -1 +1,4 @@ +============ +Contributing +============ .. include:: ../../CONTRIBUTING.rst diff --git a/{{cookiecutter.repo_name}}/doc/source/readme.rst b/{{cookiecutter.repo_name}}/doc/source/readme.rst index 72a3355..a6210d3 100644 --- a/{{cookiecutter.repo_name}}/doc/source/readme.rst +++ b/{{cookiecutter.repo_name}}/doc/source/readme.rst @@ -1 +1 @@ -.. include:: ../README.rst +.. include:: ../../README.rst diff --git a/{{cookiecutter.repo_name}}/test-requirements.txt b/{{cookiecutter.repo_name}}/test-requirements.txt index 9dab35b..f2b89da 100644 --- a/{{cookiecutter.repo_name}}/test-requirements.txt +++ b/{{cookiecutter.repo_name}}/test-requirements.txt @@ -5,7 +5,7 @@ discover fixtures>=0.3.14 python-subunit sphinx>=1.1.2 -oslo.sphinx +oslosphinx testrepository>=0.0.17 testscenarios>=0.4,<0.5 testtools>=0.9.32