graffy
/
lipase
1
0
Fork 0
Code Issues 2 Pull Requests Releases Wiki Activity
lipase/doc/sphinx/source/index.rst

31 lines
564 B
ReStructuredText
Raw Normal View History

added sphinx settings in order to use sphinx to check the syntax of arguments I'm not planning at the moment to use sphinx to generate the user documentation, as latex seems richer....
2020-04-14 10:40:50 +02:00
.. lipase documentation master file, created by
sphinx-quickstart on Tue Apr 14 10:32:30 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to lipase's documentation!
==================================
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
added sphinx settings in order to use sphinx to check the syntax of arguments I'm not planning at the moment to use sphinx to generate the user documentation, as latex seems richer....
2020-04-14 10:40:50 +02:00
.. toctree::
:maxdepth: 2
:caption: Contents:
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
imageengine
catalog
lipase
circsymdetector
traps_detector
template_matcher
maxima_finder
hdf5
telemos
added sphinx settings in order to use sphinx to check the syntax of arguments I'm not planning at the moment to use sphinx to generate the user documentation, as latex seems richer....
2020-04-14 10:40:50 +02:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`