Add examples and procedure for adding future examples to repo about hydrotools HOT 6 CLOSED

Very nice! Thanks for getting this started.

from hydrotools.

Very nice! Thanks for getting this started.

For sure. I got everything working locally, however to get the notebooks into the gh-pages deployment without a hacky solution, I had to open a PR to the nbsphinx-link project. In short, nbsphinx (the parent package to nbsphinx-link) converts jupyter notebooks to restructured text files that sphinx can render as html. In the aforementioned example directory structure, all notebook files would live outside of the sphinx docs directory. This is a problem, because sphinx "doesnt know" about files that live above the docs dir and nbsphinx does not have a way to link to notebook files outside of the docs dir. nbsphinx-link is the solution to this problem, however as the project sits now, you would have to have a config file for each notebook in /examples. This seems unnecessarily redundant. The maintainer, mentioned in a prior issue that they would be open to a PR that introduced that kind of functionality, so hopefully they will accept the change and we can use it to deploy notebooks in the project. If not, we can just use the fork I have or something like that.

from hydrotools.

Just an update to this issue. There has been no feedback or communication over the PR I put in on the nbsphinx-link project. Hoping that will change soon.

from hydrotools.

Just another update. The PR that I referenced in the previous comment still has not been attended to, so instead, in my personal time, Ive repackaged and published by forked version on PYPI under the name nbsphinx-multilink. We can now pull this in as a dependency for displaying notebooks in sphinx.

from hydrotools.

Im going to wait to make this addition until #57 has been merged.

from hydrotools.

Given the state of #88, I am going to close this for now. We can reopen for continued discussion in the future.

from hydrotools.