jjb/python-jenkins
Code Issues Proposed changes

Create module member index from autodoc

Browse Source 
Change where noindex is used to allow indexing of all the jenkins object
methods. This allows for cross reference links to methods to be created
in the documentation and sphinx will automatically generate the
necessary links.

Change-Id: Ic9c28debca382a003ae9560f0bf7943c35ef187d
This commit is contained in:
Darragh Bailey 2015-08-25 00:47:22 +01:00
parent a8655eaccc
commit acd614fae7
2 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/api.rst
View File

@ -5,5 +5,4 @@ API reference
.. automodule:: jenkins
:members:
:noindex:
:undoc-members:

1
jenkins/__init__.py
View File

@ -41,6 +41,7 @@
.. module:: jenkins
:platform: Unix, Windows
:synopsis: Python API to interact with Jenkins
:noindex:
See examples at :doc:`examples`
'''