Create docs
We had not completed the doc bootstrap on this repo. Change-Id: Id83965b9c3ec6389bb8bfaf6916150f763b03461
This commit is contained in:
parent
24a91277a0
commit
42c5d53e58
@ -15,7 +15,6 @@
|
||||
import os
|
||||
import sys
|
||||
|
||||
sys.path.insert(0, os.path.abspath('../..'))
|
||||
# -- General configuration ----------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
@ -23,7 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
#'sphinx.ext.intersphinx',
|
||||
'oslosphinx'
|
||||
'zuul_sphinx',
|
||||
]
|
||||
|
||||
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
||||
@ -38,7 +37,7 @@ master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'openstack-zuul-jobs'
|
||||
copyright = u'2016, OpenStack Foundation'
|
||||
copyright = u'2017, Zuul contributors'
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
add_function_parentheses = True
|
||||
|
@ -1,8 +1,12 @@
|
||||
.. include:: ../../README.rst
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
jobs
|
||||
roles
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
|
5
doc/source/jobs.rst
Normal file
5
doc/source/jobs.rst
Normal file
@ -0,0 +1,5 @@
|
||||
Jobs
|
||||
=====
|
||||
|
||||
.. zuul:autojobs::
|
||||
|
4
doc/source/roles.rst
Normal file
4
doc/source/roles.rst
Normal file
@ -0,0 +1,4 @@
|
||||
Roles
|
||||
=====
|
||||
|
||||
.. zuul:autoroles::
|
@ -6,8 +6,7 @@ hacking>=0.12.0,<0.13 # Apache-2.0
|
||||
|
||||
ansible-lint
|
||||
bashate>=0.2
|
||||
sphinx>=1.5.1,<1.6.0 # BSD
|
||||
oslosphinx>=4.7.0 # Apache-2.0
|
||||
zuul-sphinx>=0.1.1
|
||||
|
||||
# zuul-jobs is required to supply the ansible roles for ansible-lint
|
||||
-e git://git.openstack.org/openstack-infra/zuul-jobs#egg=zuul-jobs
|
||||
|
Loading…
Reference in New Issue
Block a user