From 42c5d53e58d2ec63efd9510c2cb23650667fea0d Mon Sep 17 00:00:00 2001 From: "James E. Blair" Date: Mon, 11 Sep 2017 12:55:32 -0600 Subject: [PATCH] Create docs We had not completed the doc bootstrap on this repo. Change-Id: Id83965b9c3ec6389bb8bfaf6916150f763b03461 --- doc/source/conf.py | 5 ++--- doc/source/index.rst | 4 ++++ doc/source/jobs.rst | 5 +++++ doc/source/roles.rst | 4 ++++ test-requirements.txt | 3 +-- 5 files changed, 16 insertions(+), 5 deletions(-) create mode 100644 doc/source/jobs.rst create mode 100644 doc/source/roles.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 6c59db55..031a8440 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 404e79f7..092f1c1e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,8 +1,12 @@ .. include:: ../../README.rst + .. toctree:: :maxdepth: 2 + jobs + roles + Indices and tables ================== diff --git a/doc/source/jobs.rst b/doc/source/jobs.rst new file mode 100644 index 00000000..1d722cb9 --- /dev/null +++ b/doc/source/jobs.rst @@ -0,0 +1,5 @@ +Jobs +===== + +.. zuul:autojobs:: + diff --git a/doc/source/roles.rst b/doc/source/roles.rst new file mode 100644 index 00000000..5baa1e4e --- /dev/null +++ b/doc/source/roles.rst @@ -0,0 +1,4 @@ +Roles +===== + +.. zuul:autoroles:: diff --git a/test-requirements.txt b/test-requirements.txt index 5b5efc35..e033bdd7 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -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