opendev/gerritlib
Code Issues Proposed changes
master
gerritlib/doc/source/index.rst

20 lines
207 B
ReStructuredText
Raw Permalink Normal View History

Update project docs This change does the following: Update docs with more info Add an example usage of this library Add pbr versioning to docs Updates the requirements Rarrange the docs to look better on pypi Lots of the elements to do above were borrowed from python-jenkins and jenkins-job-builder projects. Change-Id: Idc7dfc88cc26e1147b027fd55d41229c4bf3910f
2015-03-19 12:15:32 -07:00
Gerritlib
=========
Doc generation support Based on cookiecutter and slightly tweaked afterward. * conf.py has autoclass_content = 'both' to generate the __init__ documentation. * bumped doc copyright to 2015. * adds in tox environement 'docs' as a convenience Change-Id: I69bb4179be343ab7c8a44f6fb80d5a428fe30e17
2014-05-22 15:24:28 +02:00
Update project docs This change does the following: Update docs with more info Add an example usage of this library Add pbr versioning to docs Updates the requirements Rarrange the docs to look better on pypi Lots of the elements to do above were borrowed from python-jenkins and jenkins-job-builder projects. Change-Id: Idc7dfc88cc26e1147b027fd55d41229c4bf3910f
2015-03-19 12:15:32 -07:00
.. include:: ../../README.rst
Doc generation support Based on cookiecutter and slightly tweaked afterward. * conf.py has autoclass_content = 'both' to generate the __init__ documentation. * bumped doc copyright to 2015. * adds in tox environement 'docs' as a convenience Change-Id: I69bb4179be343ab7c8a44f6fb80d5a428fe30e17
2014-05-22 15:24:28 +02:00
Update project docs This change does the following: Update docs with more info Add an example usage of this library Add pbr versioning to docs Updates the requirements Rarrange the docs to look better on pypi Lots of the elements to do above were borrowed from python-jenkins and jenkins-job-builder projects. Change-Id: Idc7dfc88cc26e1147b027fd55d41229c4bf3910f
2015-03-19 12:15:32 -07:00
Contents
========
Doc generation support Based on cookiecutter and slightly tweaked afterward. * conf.py has autoclass_content = 'both' to generate the __init__ documentation. * bumped doc copyright to 2015. * adds in tox environement 'docs' as a convenience Change-Id: I69bb4179be343ab7c8a44f6fb80d5a428fe30e17
2014-05-22 15:24:28 +02:00
.. toctree::
Update project docs This change does the following: Update docs with more info Add an example usage of this library Add pbr versioning to docs Updates the requirements Rarrange the docs to look better on pypi Lots of the elements to do above were borrowed from python-jenkins and jenkins-job-builder projects. Change-Id: Idc7dfc88cc26e1147b027fd55d41229c4bf3910f
2015-03-19 12:15:32 -07:00
:maxdepth: 3
:glob:
Doc generation support Based on cookiecutter and slightly tweaked afterward. * conf.py has autoclass_content = 'both' to generate the __init__ documentation. * bumped doc copyright to 2015. * adds in tox environement 'docs' as a convenience Change-Id: I69bb4179be343ab7c8a44f6fb80d5a428fe30e17
2014-05-22 15:24:28 +02:00
Update project docs This change does the following: Update docs with more info Add an example usage of this library Add pbr versioning to docs Updates the requirements Rarrange the docs to look better on pypi Lots of the elements to do above were borrowed from python-jenkins and jenkins-job-builder projects. Change-Id: Idc7dfc88cc26e1147b027fd55d41229c4bf3910f
2015-03-19 12:15:32 -07:00
*
Doc generation support Based on cookiecutter and slightly tweaked afterward. * conf.py has autoclass_content = 'both' to generate the __init__ documentation. * bumped doc copyright to 2015. * adds in tox environement 'docs' as a convenience Change-Id: I69bb4179be343ab7c8a44f6fb80d5a428fe30e17
2014-05-22 15:24:28 +02:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Copy Permalink