API documentation not showing up on the site about hark HOT 10 CLOSED

Hmm, I just went to hark.readthedocs.io and it seemed to be rendering fine for me.

And both of the links above worked for me as well, at least in resulting in the download of a PDF.

Can you give the exact link that is not working for you?

from hark.

Here are the two links that I posted a pdf for:

https://hark.readthedocs.io/en/latest/reference/tools/distribution.html

https://hark.readthedocs.io/en/latest/reference/ConsumptionSaving/ConsPortfolioModel.html

from hark.

Can confirm, none of the links under this section load anything
https://hark.readthedocs.io/en/latest/reference/index.html

from hark.

I'll take a look at this.

from hark.

API docs build works locally. Checking RTD logs.

from hark.

Error shows up only on latest build for RTD, not on stable build (tied to 0.12)

from hark.

Failing Sphinx logs on latest:
https://gist.github.com/sbenthall/2444d5f99ef83247033ef2f84d949fc9

Working Sphinx logs on stable:
https://gist.github.com/sbenthall/d39ad66a5c10006e38cc31bb22473e06

The failure is due to Python modules not loading properly due to an import error:

Failed to import 'HARK.distribution': no module named HARK.distribution

WARNING: autodoc: failed to import module 'distribution' from module 'HARK'; the following exception was raised:
cannot import name 'rv_continuous_frozen' from 'scipy.stats._distn_infrastructure' (/home/docs/checkouts/readthedocs.org/user_builds/hark/envs/latest/lib/python3.7/site-packages/scipy/stats/_distn_infrastructure.py)

And likewise for many other modules...

WARNING: autodoc: failed to import module 'ConsumptionSaving.ConsIndShockModel' from module 'HARK'; the following exception was raised:
cannot import name 'rv_continuous_frozen' from 'scipy.stats._distn_infrastructure' (/home/docs/checkouts/readthedocs.org/user_builds/hark/envs/latest/lib/python3.7/site-packages/scipy/stats/_distn_infrastructure.py)

scipy v.1.7.3 is being installed in the RTD build environment with Python 3.7:

Collecting scipy
  Downloading scipy-1.7.3-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl (38.1 MB)

My local scipy install is Python 3.10, v1.9.0.

It looks like some time ago we decided to stop officially supporting Python 3.7:
#1142

Which means that there is some configuration issue where we haven't yet told RTD not to stop using 3.7

from hark.

The fix involves setting a configuration option: https://blog.readthedocs.com/sphinx6-upgrade/

from hark.

API autodocs for latest (master) are now working on RTD!

This took some finagling.
0fc0f73

• The right option to set in .readthedocs.yml is build.tools.python and it is quoted; do not use python.version
• I tried using 3.11 and 3.10 for the RTD Python build, but both of these led to build failures due to upstream Python issues. 3.9 was the latest (highest valued) version I could find that worked.

Looks like the docs are quite sensitive to the dependency stack, so it's good to kick the tires on them.
Thanks @dedwar65 for catching the issue.

from hark.

@sbenthall, FYI, I've asked @MridulS to make a proposal to Google "Summer of Docs" this summer to have someone come in and overhaul our documentation. @MridulS suggested a while ago that we should move to whatever system the cool kids are using (numpy, scipy, etc), and presumably that's something this person would implement.

from hark.