Add binder links

[sroet]

after pr #92
This PR adds the repective binder links to the

• README.md
• examples page of the documentation
• add a link to binder for every notebook
• enable jinja2 rendering for all .rst your docs

(@dwhswenson any place missing? for example I can add a link to each ipynb that would start binder for themself)

[dwhswenson]

I think README and examples should be enough. BTW, part of my upcoming examples refresh involves adding numbers to the notebooks. That will:

1. Order them correctly in the docs (although we could do that manually)

2. Order them correctly in the Binder listing.

[sroet]

I think README and examples should be enough.

Perfect, then this one is ready for a review

BTW, part of my upcoming examples refresh involves adding numbers to the notebooks. That will:

1. Order them correctly in the docs (although we could do that manually)

2. Order them correctly in the Binder listing.

Sounds great 😄

[sroet]

@dwhswenson (just FYI for the possibilities of binder; the strangest binder setup I have done allows you to run Coupled-Cluster calculations in your browser )

[dwhswenson]

Suggesting a little modification to move the Binder link higher up in the main examples page. Also, here's a better discussion of images/links/substitutions in RST than the one I linked in that comment:

• https://stackoverflow.com/a/14387603

Not necessarily for this PR, but nbsphinx has a trick for adding frontmatter that can automatically include a link to the relevant notebook on Binder:

• https://nbsphinx.readthedocs.io/en/0.4.1/prolog-and-epilog.html

(That link is also an example of this specific use in action.)

Consider that optional; if it is a pain to do, don't worry, but if it's easy, it would be nice. I don't mind having a Binder link for each page on RTD; I just didn't want to put Binder links in each ipynb, since it doesn't make sense if you've already loaded it locally.

[sroet]

Consider that optional; if it is a pain to do, don't worry, but if it's easy, it would be nice. I don't mind having a Binder link for each page on RTD; I just didn't want to put Binder links in each ipynb, since it doesn't make sense if you've already loaded it locally.

So I got it working, but this only works for releases if the docs are build from a release install of contact_map (because it checks if the installed version of cantact map contains "dev")

[EDIT]
A bit of explanation of the version setting in the notebooks.

1. If dev is part of the contact_map version we set the links to master (We assume that you want to build for latest in that case)
2. else we set the version as v+version (I assumed our tags will always have that name)

[sroet]

one thing that I could not figure out:
The link properly in docs/examples/index.rst can not be set depending on the version as that one does not seem to pass through jinja2 before converting to html

nvm, fixed it

[sroet]

Alright, I also added jinja2 rendering for all the .rst, so you can do some logic in them as well. (All the jinja2 code in the .rst has access to all variables in the html_context dictionary.)

[sroet]

These will be the variables that are available to jinja2 code in the .rst

[sroet]

this html_context is the dictionary build on line 69 and will provide the variables that jinja2 will put in scope during rendering.

[dwhswenson]

One very small change, then it looks good!

[sroet]

Thanks! Corrected that one