weecology / DeepForest

Python Package for Airborne RGB machine learning
https://deepforest.readthedocs.io/
MIT License
519 stars 175 forks source link

readthedocs don't show sphinx-apidoc generated html #28

Closed bw4sz closed 4 years ago

bw4sz commented 4 years ago

this works locally, but is empty online.

DeepForest/docs/_build/html/source/deepforest.html#module-deepforest.tfrecords

bw4sz commented 4 years ago

readthedocs module html is just empty

https://deepforest.readthedocs.io/en/master/source/deepforest.html#deepforest-tfrecords-module

but nothing looks wrong in the build.

https://readthedocs.org/projects/deepforest/builds/10026514/

and the docs looks fine locally.

image

@henrykironde any guesses? I'm working from https://github.com/readthedocs/readthedocs.org/issues/3634

bw4sz commented 4 years ago

Looking at raw logs, I see warnings that didn't end the build.

WARNING: autodoc: failed to import module 'deepforest' from module 'deepforest'; the following exception was raised:
No module named 'tensorflow'
WARNING: autodoc: failed to import module 'predict' from module 'deepforest'; the following exception was raised:
No module named 'numpy'
WARNING: autodoc: failed to import module 'preprocess' from module 'deepforest'; the following exception was raised:
No module named 'pandas'
WARNING: autodoc: failed to import module 'retinanet_train' from module 'deepforest'; the following exception was raised:
No module named 'keras'
WARNING: autodoc: failed to import module 'tfrecords' from module 'deepforest'; the following exception was raised:
No module named 'tensorflow'
WARNING: autodoc: failed to import module 'utilities' from module 'deepforest'; the following exception was raised:
No module named 'yaml'
WARNING: autodoc: failed to import module 'setup'; the module executes module level statement and it might call sys.exit().
WARNING: autodoc: failed to import module 'test_deepforest' from module 'tests'; the following exception was raised:
No module named 'pytest'
WARNING: autodoc: failed to import module 'test_preprocess' from module 'tests'; the following exception was raised:
No module named 'numpy'
WARNING: autodoc: failed to import module 'test_tfrecords' from module 'tests'; the following exception was raised:
No module named 'tensorflow'
WARNING: autodoc: failed to import module 'test_utilities' from module 'tests'; the following exception was raised:
No module named 'yaml'
WARNING: autodoc: failed to import module 'test_deepforest' from module 'tests'; the following exception was raised:
No module named 'pytest'
WARNING: autodoc: failed to import module 'test_preprocess' from module 'tests'; the following exception was raised:
No module named 'numpy'
WARNING: autodoc: failed to import module 'test_tfrecords' from module 'tests'; the following exception was raised:
No module named 'tensorflow'
WARNING: autodoc: failed to import module 'test_utilities' from module 'tests'; the following exception was raised:
No module named 'yaml'

Why does read the docs need access to the source libraries to render the already created html?

bw4sz commented 4 years ago

turned

Requirements file off in readthedocs settings.
A pip requirements file needed to build your documentation. Path from the root of your project. 

warnings still persist. the html is already rendered, I'm not following the workflow.

bw4sz commented 4 years ago

https://stackoverflow.com/questions/36678131/readthedocs-not-parsing-docstrings-in-python-modules-sphinx

Usage of Sphinx's autodoc to create documentation from docstring comments requires that Python files be loaded and hence all of the modules that they import will so too be imported. 
bw4sz commented 4 years ago

Needed a readthedocs.yml to point to the environment.yml

everything looks good. https://deepforest.readthedocs.io/en/latest/source/deepforest.html#module-deepforest.preprocess