Closed will-moore closed 3 years ago
And the built docs are at https://will-moore-omero-scripts.readthedocs.io/en/latest/
Nice! (even if very Kymograph focused :wink:)
It's a shame that it requires all the sphinx boilerplate though.
I don't know that it requires all the sphinx boilerplate. That's just what you get from following
$ sphinx-quickstart
https://www.sphinx-doc.org/en/master/usage/quickstart.html
Trying to build a module instead of a single script: https://github.com/ome/omero-scripts/pull/176/commits/b7351ac4160c44eb1616a574e089bbe5fe30db05 fails to include any autodoc output, although the docs build passes: https://readthedocs.org/projects/will-moore-omero-scripts/builds/12100895/ Also, can't test the build locally (as mentioned above).
How did you create your conda env?
I think I followed the docs Python bindings page install instructions.
so you are using python3, just trying to narrow down the problem
Travis is failing due to integration tests failing with omero.NoProcessorAvailable: exception ::omero::NoProcessorAvailable
.
OK to ignore for now.
Yes, python 3
.
It seems that sphinx is not designed to auto-document a whole project (https://groups.google.com/g/sphinx-users/c/ZZTFVGbW5Q4) So I reverted to specifying individual scripts in the last commit, adding a new docs/analysis_scripts.rst page and adding this to the toctree. The page was built OK (https://will-moore-omero-scripts.readthedocs.io/en/latest/analysis_scripts.html) but I don't see any link to it (no toctree) in the home page https://will-moore-omero-scripts.readthedocs.io/en/latest/index.html
@jburel Any ideas what I'm doing wrong here?
It seems that sphinx is not designed to auto-document a whole project (https://groups.google.com/g/sphinx-users/c/ZZTFVGbW5Q4)
Hmm... maybe I'm misunderstanding, but I'm pretty sure it should be possible to do what you want, though it may require placeholders under docs/...
which point to given classes and/or modules like https://github.com/spacetx/starfish/blob/master/docs/source/api/spots/index.rst#detecting-pixels
This is the result of attempting to learn how to build Sphinx docs with autodoc to include docs built from docstrings.
Currently, my master branch is being built with https://readthedocs.org/projects/will-moore-omero-scripts/ And the built docs are at https://will-moore-omero-scripts.readthedocs.io/en/latest/
This is just building docs for one Kymograph script so far... Since this repo doesn't have any
requirements.txt
yet, I created one underdocs/requirements.txt
. Seems to installomero-py
fine.But, when I try to build locally, it fails to import
omero
, although it is installed in my current conda env.cc @manics @joshmoore