24451d1689
Add Python API and test indices to rendered documentation. This is rudimentary for now, but will get better as useful docstrings are added to the Python source. Change-Id: I723ee931e3c219ce08c3d24f79e862e8b304733e
38 lines
692 B
ReStructuredText
38 lines
692 B
ReStructuredText
============
|
|
Contributing
|
|
============
|
|
.. include:: ../../CONTRIBUTING.rst
|
|
|
|
|
|
Python API
|
|
----------
|
|
|
|
No internal API stability guarantees are made, but for reference
|
|
here is a basic outline of the source implementation:
|
|
|
|
.. automodule:: bindep
|
|
:members:
|
|
|
|
.. automodule:: bindep.depends
|
|
:members:
|
|
|
|
.. automodule:: bindep.main
|
|
:members:
|
|
|
|
|
|
Internal Unit Tests
|
|
-------------------
|
|
|
|
The bindep utility is developed following a test-driven methodology.
|
|
These are the current tests run to ensure its internal consistency
|
|
for every commit:
|
|
|
|
.. automodule:: bindep.tests
|
|
:members:
|
|
|
|
.. automodule:: bindep.tests.test_depends
|
|
:members:
|
|
|
|
.. automodule:: bindep.tests.test_main
|
|
:members:
|