HTML: Add download link for the current notebook

[mgeier]

Ideally, this should already work with the "Source" link (but currently it doesn't).

We could also include an (optional) link above or below the first section title (like here) or at the bottom of the page (like here).

[mgeier]

It would probably also be nice, instead of having a link to a copy of the file, to have a link to the Github/Bitbucket page of the (proper version of the) notebook.

These links might be interesting:
https://pypi.python.org/pypi/sphinxcontrib-srclinks
https://gist.github.com/MantasVaitkunas/7c16de233812adcb7028
http://mg.pov.lt/blog/sphinx-edit-on-github.html

[mgeier]

I just asked for this on the sphinx-dev mailing list: https://groups.google.com/forum/#!topic/sphinx-dev/q8dGyV6dN4A

[mgeier]

I've created a PR for Sphinx: sphinx-doc/sphinx#2399

[mgeier]

I've mentioned the option html_sourcelink_suffix in 8566fe7.

[ketch]

Just for others who arrive here, the quick solution (not yet in the docs, as far as I can tell) is to add the following to conf.py:

html_sourcelink_suffix = ''

Then if one right-clicks on the "show source" link and saves the file, it will have the correct .ipynb extension.

It would still be nice to add a more obvious link to download the notebook (in my opinion).

[mgeier]

@ketch Thanks for mentioning that. I consider doc/conf.py part of the documentation, therefore it is documented. If you think it should also be mentioned somewhere else in the documentation, please make a PR!

It would still be nice to add a more obvious link to download the notebook (in my opinion)

Definitely!
I'm hoping for contributions!

[mgeier]

@ketch

It would still be nice to add a more obvious link to download the notebook (in my opinion).

I've just created #150, which could be used to create an arbitrarily obvious download link.

What do you think about it?

[mgeier]

I've just released version 0.3.0, which includes the options nbsphinx_prolog and nbsphinx_epilog, which can be used to create download links, see http://nbsphinx.readthedocs.io/en/0.3.0/prolog-and-epilog.html.