API Reference not working on readthedocs

noaa-oar-arl / monet

The Model and ObservatioN Evaluation Toolkit (MONET)

https://monet-arl.readthedocs.io

Other

44 stars 20 forks source link

Closed fsenf closed 4 years ago

fsenf commented 4 years ago

Hi all,

I guess, you are aware, but API reference documentation is not working on readthedocs. I will have a look on it.

Readthedocs:

needs to import monet module
it therefore builds a docker image and installs all required package ( a docs/requirement file is helpful )
after import it tries to resolve all functions

Cheers, Fabian

bbakernoaa commented 4 years ago

@fsenf This is awesome. Thanks for helping with this. I've merged the changes into my master branch and the docs built successfully :)

bbakernoaa commented 4 years ago

It appears to be missing a few of the .rst files. When I did the restructuring last month I broke the docs. sorry

fsenf commented 4 years ago

Great to see.!

The issue comes with the cartopy module.

Installation wiht pipdoes work because it needs some external libraries.
I tried RTD configuraiton with conda. In this case, I got memory consumption problems (RTD user limit).
The best way that the moment is to "mock" the cartopy module in the conf.py