Cleanup docs builds and error on warnings
The docs builds throw quite a few exceptions and warnings. Most of this is due to code that has moved around so autodoc can't import code to document that code. Update the names for code that has moved. There were also so small docstring indentation issues that are corrected. In addition to fixing these issues, update the minimum version of sphinx and set warning-is-error so that we avoid these problems in the future by gating on making sure they don't exist. Change-Id: Ic06775e7d1c8fbbfc5a8e6c412a2ad15f8699413
This commit is contained in:
parent
788af45d30
commit
500992b37d
|
@ -26,12 +26,12 @@ A :py:class:`~zuul.model.Pipeline` has one or more
|
|||
|
||||
A :py:class:`~zuul.model.Job` represents the definition of what to do. A
|
||||
:py:class:`~zuul.model.Build` represents a single run of a
|
||||
:py:class:`~zuul.model.Job`. A :py:class:`~zuul.model.JobTree` is used to
|
||||
:py:class:`~zuul.model.Job`. A :py:class:`~zuul.model.JobGraph` is used to
|
||||
encapsulate the dependencies between one or more :py:class:`~zuul.model.Job`
|
||||
objects.
|
||||
|
||||
.. autoclass:: zuul.model.Job
|
||||
.. autoclass:: zuul.model.JobTree
|
||||
.. autoclass:: zuul.model.JobGraph
|
||||
.. autoclass:: zuul.model.Build
|
||||
|
||||
The :py:class:`~zuul.manager.base.PipelineManager` enqueues each
|
||||
|
@ -48,7 +48,6 @@ a :py:class:`~zuul.model.BuildSet`
|
|||
Changes
|
||||
~~~~~~~
|
||||
|
||||
.. autoclass:: zuul.model.Changeish
|
||||
.. autoclass:: zuul.model.Change
|
||||
.. autoclass:: zuul.model.Ref
|
||||
|
||||
|
|
|
@ -19,7 +19,7 @@ the environment being simulated in the test:
|
|||
.. autoclass:: tests.base.FakeGearmanServer
|
||||
:members:
|
||||
|
||||
.. autoclass:: tests.base.RecordingLaunchServer
|
||||
.. autoclass:: tests.base.RecordingExecutorServer
|
||||
:members:
|
||||
|
||||
.. autoclass:: tests.base.FakeBuild
|
||||
|
|
|
@ -31,6 +31,7 @@ console_scripts =
|
|||
source-dir = doc/source
|
||||
build-dir = doc/build
|
||||
all_files = 1
|
||||
warning-is-error = 1
|
||||
|
||||
[extras]
|
||||
mysql_reporter=
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
hacking>=0.12.0,!=0.13.0,<0.14 # Apache-2.0
|
||||
|
||||
coverage>=3.6
|
||||
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
|
||||
sphinx>=1.5.1
|
||||
sphinxcontrib-blockdiag>=1.1.0
|
||||
fixtures>=0.3.14
|
||||
python-keystoneclient>=0.4.2
|
||||
|
|
Loading…
Reference in New Issue