Local Sphinx rebuild does not get docstrings

[llorracc]

I'm trying to build the sphinx documentation locally, but have had only partial success.

The documentation in Documentation/instructions.txt seems very badly out of date, but assuming all of the various prep steps that it describes are correctly configured, it looked like all I'd need to do to recompile the docs was

make html

in the appropriate directory (after installing various dependencies).

This sort of works, in that sphinx fires up and runs for a while. But it only seems to compile a few things; in particular, it is not getting the docstrings for code in ConsIndShockModel.py.

Probably there is some configuration file somewhere that needs to be set to tell it to recompile everything? Or, if I could just get it to recompile things in ConsIndShockModel.py, that would be even better (because faster).

[MridulS]

Yeah Documentation/instructions.txt is indeed outdated. Could you try the following steps:

# fresh env
$ cd HARK
$ pip install -U -r requirements.txt
$ cd Documentation
$ make html

This did throw some linking warnings between example notebooks (I'll fix them) but I was able build the API reference including for ConsIndShockModel.py.

Could you confirm if this works for you?

[It will generate the files in the folder ../../hark-docs relative to the folder Documentation]