Interact Button in Documentation

[isaacgsmith]

Description

Adds a button in the documentation that allows you to launch binder.

Examples

See this page for an example: https://smithis7.github.io/tardis/branch/interact_badge_doc/quickstart/quickstart.html

Type of change

• Bug fix.
• New feature.
• Breaking change.
• None of the above.

Checklist

• My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • (optional) I have built the documentation on my fork following the instructions.
• I have assigned and requested two reviewers for this pull request.

[codecov]

Codecov Report

Merging #1697 (4deba21) into master (2010e81) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1697   +/-   ##
=======================================
  Coverage   61.88%   61.88%           
=======================================
  Files          63       63           
  Lines        5851     5851           
=======================================
  Hits         3621     3621           
  Misses       2230     2230           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2010e81...4deba21. Read the comment docs.

[tardis-bot]

Before a pull request is accepted, it must meet the following criteria:

• Is the necessary information provided?
• Is this a duplicate PR?
  • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
  • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
• Does it pass existing tests and are new tests provided if required?
  • The test coverage should not decrease, and for new features should be close to 100%.
• Is the code tidy?
  • No unnecessary print lines or code comments.

[jaladh-singhal]

Looks great - there's one thing that I missed last time.

[jaladh-singhal]

Looks as expected! Thanks for changes.

[epassaro]

My opinion is we should take care of the aesthetic of the documentation. Personally, I don't like the changes so much (specially the second line of text). Also, adding a block of CSS code seems overcomplicated for a task that should be easy to solve with shields.io .

Anyway, the button works as expected and that's not an easy job! Congrats. Feel free to merge this if you are satisfied with the results.

[DhruvSondhi]

This addition seems to be good as we are trying to integrate Binder with TARDIS code notebooks. I would agree that with @epassaro on the fact that this CSS needs to be added in the nbsphinx prolog. Prologs & Epilogs allow us to add anything in the r""" & it will be appended before the main documentation (only where nbsphinx is working). Keeping that in mind, the page may become unresponsive or laggy if the load is increased via Binder via the button.
Another thing is that there should be a way to access the Binder Repository from the Main Documentation page such that the user should not be just navigating the documentation to find a Page that has this button & then click on it to access it via Binder. It should allow the user to check for all the possible Binder Pages that can be accessed.

[jaladh-singhal]

My opinion is we should take care of the aesthetic of the documentation.

@epassaro We used the same white shade text on blue shade background as on top left (where tardis home is mentioned). Can you please elaborate what do you think that can be improved?

Personally, I don't like the changes so much (specially the second line of text).

@epassaro Where do you think is better to put second line of text?

Also, adding a block of CSS code seems overcomplicated for a task that should be easy to solve with shields.io

That's true but for some users it's not identifiably clickable as @smithis7 pointed out - so I have to write CSS to create an actual button.

[jaladh-singhal]

I would agree that with @epassaro on the fact that this CSS needs to be added in the nbsphinx prolog

@DhruvSondhi it's already added in prolog - check the code. Did you mean something else - let me know if there's better place to put it?

[epassaro]

My opinion is we should take care of the aesthetic of the documentation.

@epassaro We used the same white shade text on blue shade background as on top left (where tardis home is mentioned). Can you please elaborate what do you think that can be improved?

Personally, I don't like the changes so much (specially the second line of text).

@epassaro Where do you think is better to put second line of text?

Also, adding a block of CSS code seems overcomplicated for a task that should be easy to solve with shields.io

That's true but for some users it's not identifiably clickable as @smithis7 pointed out - so I have to write CSS to create an actual button.

---

I found the choice of words redundant (interact-interactive, you can x2), not sure about using a semicolon before the button. Also, I'm not a fan of title case, but I'm not a native English speaker so probably it's just in my head.

You can interact with this notebook online: Launch Interactive Version

And you can download it from GitHub.

About the second line: I found it too short, not worthing a new line.

[andrewfullard]

Are we actually happy with this? @epassaro do you want us to wait for further discussion before merging?

[jaladh-singhal]

I found the choice of words redundant (interact-interactive, you can x2)

Accounted, also made clear the benefit of launching interactive version is no need of installing locally if user is interested after playing with it then they can.

not sure about using a semicolon before the button.

It's because it's an inline button - I tried without colon, that looks more odd

Also, I'm not a fan of title case, but I'm not a native English speaker so probably it's just in my head.

I can understand it may appear to loud to some users, changed to sentence style - I missed it rule 5 in the article I shared also says so.

About the second line: I found it too short, not worthing a new line.

Accounted made it bit descriptive and complimentary to 1st line. And in same line it looks too cluttered - also bear in mind that we will reduce width of main page container to 800px (#1687) in coming days (so there won't be that much white space).

@epassaro @smithis7 check this out with all changes:

[jaladh-singhal]

@smithis7 can you make the changes in code as per screenshot I shared (they're mostly textual edits)?