improve appearance

[OriolAbril]

Work on the overall appearance of the website.

• Add "view on github", "launch on binder" and "open with collab" badges to all posts. Only
  notebooks with the post directive will have this. Partial resolution of Guidance/standardization of "front matter" #200, and it is automated.
  • binder env still needs to be configured though.
• Add postcard information to the left sidebar. This will include tags and categories (thus this fixes Show tags and categories within notebook posts #235) but it could
  be interesting to include authors too as discussed in Standardize authorship attribution #198.
  • The current proposal is a bit clunky but might work well enough. It does have a bit of repeated info though which is not ideal. I have basically hijacked the ablog template to include the authors with a link to #authors which should then be set and contain the authorship info, links to the profiles of authors...
• Make the sidebar scrollable, see Only the toctree section of the left sidebar is scrollable pydata/pydata-sphinx-theme#500 This will soon be fixed directly by the theme in a much more pretty way than what I first did here.
• Fix logos and PyMC3 instances in sphinx config; the notebooks and tags still need updating.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[OriolAbril]

Here is how the spline example looks like for example: https://pymc-examples--239.org.readthedocs.build/en/239/splines/spline.html which is where I have added authors to the post directive to show how it looks like cc @tjburch

[tjburch]

@OriolAbril I really like the look of having authors in the sidebar! Would it be annoying to have a separate tag for original author and then one for supplemental contributors? e.g. in this example, I just fixed some plots - I feel a little bad appearing side-by-side with the original author. Maybe this is a null point, since the contributions are at the end and not worth worrying about though.

[OriolAbril]

Would it be annoying to have a separate tag for original author and then one for supplemental contributors?

That would mean modifying the ablog extension which is something above my skills

[tjburch]

oof yeah, not worth it. Great as-is then.

[martinacantaro]

This is not a hard preference, but I would prefer authorship to be at the end of the notebook, and in line with this proposal. I like it better because it has more nuance than displaying the names of everybody who made a contribution, which would put someone who fixed a typo at the same level of someone who created the entire thing.

I think this is useful for readers in cases where they want to know who did the main work for a notebook (for example, if they need to quote the notebook, or if they want to get in touch with the author).

Also, I think for the purposes of documentation it's not as important to display authorship prominently, so I would leave the sidebar for categories and tags.

[OriolAbril]

todos:

• update the requirements to codeautolink released version, not github
• add doi link and code to html_config once we have them. There is an issue with the webhook right now and they have not been generated even after my fake releases.
• (for someone else who knows pre-commit to do) Add a pre-commit check to ensure all notebooks end with the include page_footer directive and if possible add it automatically when missing.
• with metadata, list of tags and categories... the bottom categories end up hidden. This will be automatically fixed by the next release of the pydata theme so it's a todo that will solve itself alone

[OriolAbril]

Now realized a bit of info on codeautolink is probably in order. It is a sphinx extension that automatically converts the python objects from the libraries configured on intersphinx-mappings to links to their relevant api pages. It is very new and still needs some tweaks, but it is very active and works perfectly well.

Here are some examples form their docs: https://sphinx-codeautolink.readthedocs.io/en/latest/examples.html

[OriolAbril]

Ready to merge and I'll merge this weekend even without any other approving review.

[michaelosthege]

that are tied togehter at their boundaries
                  ☝

Reply via ReviewNB

[michaelosthege]

Found a typo that was there before.

Also the spline notebook still uses "PyMC3", not sure if you want to change that already.

[OriolAbril]

Also the spline notebook still uses "PyMC3", not sure if you want to change that already.

We'll need to rerun them all with v4, so we can take care of that then. So far I have not updated that anywhere in notebooks, only in readme and templates.