errors in pyclaw docs - Githubissues

rjleveque commented 6 years ago

@mandli and @ketch: I thought we had fixed all the errors in the pyclaw docs but now there seem to be many again, did we miss merging something in to pyclaw?

See these in particular:

ketch commented 6 years ago

The error on the IO page is because the docs were built without an installation of h5py, I guess. The others seem to be things that I missed. I'll prepare a new PR and try to catch everything.

rjleveque commented 6 years ago

There were also some incorrect pointers to the old io rather than new fileio directory in io.rst. I have fixed these.

rjleveque commented 6 years ago

I think all the pyclaw docs look fine now except

http://www.clawpack.org/pyclaw/io.html

I've got a conda environment into which I installed h5py and also sphinx-versioning, so I now have a directory /Users/rjl/miniconda/envs/rbook2/lib/python3.6/site-packages/sphinx/ext/autodoc, but sphinx still throws the error

autodoc: failed to import module u’clawpack.pyclaw.fileio.hdf5’; 
the following exception was raised: Traceback (most recent call last): File
 “/usr/local/Cellar/python/2.7.12_2/Frameworks/Python.framework/Versions/2.7/lib/python2.7/site-packages/sphinx/ext/autodoc.py”

So it's using the wrong version of python and/or autdoc (and I don't have an autodoc.py in my environment, only an autodoc folder).

Any ideas?

mandli commented 6 years ago

That looks like a homebrew Python installation. Did you need that version? You might able to just uninstall that one.

clawpack / doc

errors in pyclaw docs #190