lipase/doc/sphinx/source/catalog.rst


The catalog module
------------------

.. automodule:: lipase.catalog
   :members:
configured sphinx to generate decent api documentation This was primarily done to detect bad restructuredtext syntax in python code. This allowed me to detect and fix quite a few errors. In order to fix the orrors in the output document, I also added quite a lot of docstrings, as sphinx autodoc ignores classes and functions that don't have docstrings. This was my first experience with sphinx but I'm not quite happy with it, as it requires too much verbose and time consuming helps and hinting to produce something decent. Moreobver, it suffers from a lack of examples for non basic usage, such as : - how to expose to the user the __item__ methods - how to document multiple return values - etc. 2020-04-14 18:58:03 +02:00
			`The catalog module`
			`------------------`

			`.. automodule:: lipase.catalog`
			`:members:`