Sphinx breaking on notebook parsing

[sbenthall]

See #406 (comment)

[sbenthall]

Removing the notebooks from the autosummary list in the index.rst documentation fixes this.

https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html

It doesn't make sense for autosummarize notebooks anyway. The code is not API code.

Fixing this problem reveals another breaking exception to make html:

Exception occurred:
  File "/home/sb/projects/econ-ark/HARK/HARK/cstwMPC/MakeCSTWfigs.py", line 16, in <module>
    f = open(my_file_path  + '/Results/LCbetaPointNetWorthLorenzFig.txt','r')
FileNotFoundError: [Errno 2] No such file or directory: '/home/sb/projects/econ-ark/HARK/HARK/cstwMPC/Results/LCbetaPointNetWorthLorenzFig.txt'

[sbenthall]

The breaking file is in the HARK/cstwMPC project directory, which is slated for removal. See PR #334
It also appears to be a standalone script, rather than a library.
So it should not be involved in autogenerated API documentation--it is not specifying anything with an API.

I'll remove this and similarly misplaced files from the autosummary list.

[sbenthall]

Sphinx warning:

/home/sb/projects/econ-ark/HARK/Documentation/notebooks/DCT-Copula-Illustration.rst: WARNING: document not readable. Ignored.

The symlink here points to a file that's missing from the repository: ../../DCT-Copula-Illustration.ipynb

That looks like an incorrect path anyway; there is a working symlink to ../../Examples/Gentle-Intro-To-HARK.ipynb, but there is no DCT-Copula-Illustration.ipynb notebook in the Examples directory either.

[sbenthall]

Using sphinx html, recommonmark is erroring; it looks like it's erroring in the parsing of the HARKManual.

reading sources... [  4%] HARKmanual                                            
Exception occurred:
  File "/home/sb/anaconda3/lib/python3.6/site-packages/recommonmark/parser.py", line 211, in visit_image
    img_node['alt'] = ''.join(content)
TypeError: sequence item 1: expected str instance, NoneType found

There are also still autosummary errors.

As there seems to be a lot of work here I'll stop updating this issue and report the work in the upcoming PR.

[sbenthall]

The solution to the recommonmark error appears to be...removing the recommonmark extension.
Then sphinx executes without error and builds HTML files.

I'm not sure what recommonmark was doing and it may have been there for a good reason.

[sbenthall]

Fixed with #411