Documentation

Documentation

• latest documentation is available here: https://tomotools.gitlab-pages.esrf.fr/tomwer/

• previous version documentation can be found here: https://readthedocs.org/projects/tomwer/

In order to generate the html documentation you can use:

sphinx-build doc build/html

To generate the htmlhelp documentation please use:

sphinx-build -b htmlhelp doc build/htmlhelp

Orange widget docs

The orange-canvas allows to provide help for each widget (using F5 for example).

For it add-on must define the path to the documentation and pattern to access widgets help. This part is defined in orangecontrib/tomwer/__init__.py under the WIDGET_HELP_PATH variable. It define a list of entry point to be treated and a pattern to determine the widget help.

Adding some ‘extra layer’ such as grid-item-card… add complexity to the widget documentation.

To ease this we created the doc/canvas.widget.widget.rst file which contains a simple link to all widget and ease link to orangecanvas help. So please make sure widget help are available from there.