openstack/ui-cookiecutter
Code Issues Proposed changes

Fix documentation template issues

Browse Source 
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
This commit is contained in:
Mathew Odden 2014-05-20 17:35:10 -05:00
parent 2ea879ee42
commit 83b5d0fb1d
4 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
{{cookiecutter.repo_name}}/doc/source/conf.py
View File

@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx', #'sphinx.ext.intersphinx',
'oslo.sphinx' 'oslosphinx'
] ]
# autodoc generation is a bit aggressive and a nuisance when doing heavy # autodoc generation is a bit aggressive and a nuisance when doing heavy

3
{{cookiecutter.repo_name}}/doc/source/contributing.rst
View File

@ -1 +1,4 @@
============
Contributing
============
.. include:: ../../CONTRIBUTING.rst .. include:: ../../CONTRIBUTING.rst

2
{{cookiecutter.repo_name}}/doc/source/readme.rst
View File

@ -1 +1 @@
.. include:: ../README.rst .. include:: ../../README.rst

2
{{cookiecutter.repo_name}}/test-requirements.txt
View File

@ -5,7 +5,7 @@ discover
fixtures>=0.3.14 fixtures>=0.3.14
python-subunit python-subunit
sphinx>=1.1.2 sphinx>=1.1.2
oslo.sphinx oslosphinx
testrepository>=0.0.17 testrepository>=0.0.17
testscenarios>=0.4,<0.5 testscenarios>=0.4,<0.5
testtools>=0.9.32 testtools>=0.9.32