Docs on readthedocs

[jburel]

This PR follows up on some work started by @will-moore It publishes the doc on readthedocs. see https://jburel-omero-scripts.readthedocs.io/en/latest/

The link in the README under Usage is not working. This is the suggestion for the final link we could use "ome" too.

Improve layout in readme too see https://github.com/jburel/scripts/tree/docs_sphinx

To test locally c53d456

• Delete a script
• Run make html in the docs
• A warning should be printed out in the console

[joshmoore]

certainly looks nice, J-m! Did you notice whether or not there's a warning/error if a script is added but not linked in the docs?

[jburel]

There is no warning or error by default. This will require some code in config.py to scan the scripts directory and compare with the list of entries with automodule

[jburel]

if the script is listed using "automodule" and does not exist, there is a warning

WARNING: autodoc: failed to import module 'Kymograph'; the following exception was raised:
No module named 'Kymograph'

So I need to add a check for the situation when we have a script but no entry in the doc.

[jburel]

The readthedocs webhook will build when a PR is merged into master that will become the "latest" as it stands For the url, we can use either the canonical or a domain specific. It might be easier to the canonical especially if we roll out that strategy across the various repositories

[jburel]

see https://docs.readthedocs.io/en/stable/versions.html

[jburel]

Replaced by https://github.com/ome/omero-scripts/pull/187