c34d85fbc5
- Put in place sphinx mechanism to build documentation. Most of the documentation is generated from python docstrings. - redfish-client.py usage is a bit modified to display a decent documentation. - A link rfclient.py to redfish-client.py was created to allow sphinx parsing. The '-' char is not allowed for module and so sphinx autodoc module. - Note : Copyright may need to be reviewed as well as main.py.
27 lines
525 B
ReStructuredText
27 lines
525 B
ReStructuredText
.. python-redfish documentation master file, created by
|
|
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Welcome to python-redfish's documentation!
|
|
========================================================
|
|
|
|
Contents:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
readme
|
|
installation
|
|
usage
|
|
contributing
|
|
classesdoc
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|