Make sphinx compileable
Actually testing things is probably pretty important
This commit is contained in:
parent
f421e329a4
commit
b0c9859844
@ -1,3 +1,7 @@
|
|||||||
|
=============================================
|
||||||
|
Contributing to: {{ cookiecutter.repo_name }}
|
||||||
|
=============================================
|
||||||
|
|
||||||
If you would like to contribute to the development of OpenStack,
|
If you would like to contribute to the development of OpenStack,
|
||||||
you must follow the steps in the "If you're a developer, start here"
|
you must follow the steps in the "If you're a developer, start here"
|
||||||
section of this page:
|
section of this page:
|
||||||
|
@ -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
|
||||||
|
@ -1 +0,0 @@
|
|||||||
.. include:: ../../CONTRIBUTING.rst
|
|
1
{{cookiecutter.repo_name}}/doc/source/contributing.rst
Symbolic link
1
{{cookiecutter.repo_name}}/doc/source/contributing.rst
Symbolic link
@ -0,0 +1 @@
|
|||||||
|
../../CONTRIBUTING.rst
|
@ -18,9 +18,10 @@
|
|||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
readme <readme>
|
|
||||||
contributing <contributing>
|
README <readme>
|
||||||
Sample Template <template.rst>
|
contributing
|
||||||
|
Sample Template <template>
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
|
@ -1 +0,0 @@
|
|||||||
.. include:: ../README.rst
|
|
1
{{cookiecutter.repo_name}}/doc/source/readme.rst
Symbolic link
1
{{cookiecutter.repo_name}}/doc/source/readme.rst
Symbolic link
@ -0,0 +1 @@
|
|||||||
|
../../README.rst
|
@ -1 +0,0 @@
|
|||||||
.. include:: ../template.rst
|
|
1
{{cookiecutter.repo_name}}/doc/source/template.rst
Symbolic link
1
{{cookiecutter.repo_name}}/doc/source/template.rst
Symbolic link
@ -0,0 +1 @@
|
|||||||
|
../../template.rst
|
Loading…
x
Reference in New Issue
Block a user