search

VeinsOfTheEarth / RivGraph

Extracting and quantifying graphical representations of river and delta channel networks from binary masks
https://veinsoftheearth.github.io/RivGraph/
Other
84 stars 26 forks source link

API documentation is blank #89

Closed elbeejay closed 2 years ago

elbeejay commented 2 years ago

Need to investigate and fix hosted documentation to show the API Reference information. Example empty page here.

jonschwenk commented 2 years ago

It didn't used to be like this, right?

elbeejay commented 2 years ago

Correct, it was definitely working at some point

jonschwenk commented 2 years ago

Any idea how to diagnose? Some googling suggests that if all the packages can't be imported, sphinx-autodoc could spit out blank pages like we're seeing. There is a warning from the last doc build reminding us that mamba installs may result in unexpected environments...

https://stackoverflow.com/questions/69947560/docstrings-not-populating-sphinx-documentation and https://stackoverflow.com/questions/54965707/sphinx-apidoc-not-automated-enough

elbeejay commented 2 years ago

Any idea how to diagnose?

I don't know, but it's something I can look into when I get a chance to spin up a local environment and fiddle with it. Will check out those links. I think the biggest change was probably when we stopped mocking the dependencies and installed rivgraph for the docs build and set up the gallery (https://github.com/VeinsOfTheEarth/RivGraph/commit/3797d7ebe9dce0cf097d45d04046b7a6b45680be), so it could very well be the warning you identified.