improve appearance (pymc-devs#239)

* improve appearance * get tags and categories to show in all pages, not only posts * further improvements * try adding codeautolink * add auto footer with license and citation * fix template * some updates to readme * update citations with DOI * update templates * update requirements * fix citations and hide authors from exerpts * fix typo
martiningram · Nov 13, 2021 · f20876a · f20876a
1 parent ff2af9f
commit f20876a
Show file tree

Hide file tree

Showing 23 changed files with 341 additions and 116 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -12,8 +12,8 @@ Explain the bug, error or mistake, where it is in the notebook, if it happens
 only once or multiple times...
 
 *Note that this issue tracker is about the contents in the notebooks, if
-the notebook is instead triggering a bug or error in pymc3, please
-report to https://github.com/pymc-devs/pymc3/issues instead*
+the notebook is instead triggering a bug or error in pymc, please
+report to https://github.com/pymc-devs/pymc/issues instead*
 
 ## Expected output
 If applicable, describe what should happen instead.

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -2,7 +2,7 @@ blank_issues_enabled: false
 contact_links:
   - name: PyMC Discourse
     url: https://discourse.pymc.io/
-    about: Ask usage questions about PyMC3 or doubts about the examples here
-  - name: PyMC3 bug report
-    url: https://github.com/pymc-devs/pymc3/issues
-    about: Please report bugs or propose enhancements of the PyMC3 library here.
+    about: Ask usage questions about PyMC or doubts about the examples. If not sure where to ask, ask on Discourse.
+  - name: PyMC bug report
+    url: https://github.com/pymc-devs/pymc/issues
+    about: Please report bugs or propose enhancements of the PyMC library here.
diff --git a/.github/ISSUE_TEMPLATE/notebook-proposal.md b/.github/ISSUE_TEMPLATE/notebook-proposal.md
@@ -9,7 +9,7 @@ labels: proposal
 **Title**: Use this also as issue title
 
 ## Why should this notebook be added to pymc-examples?
-Explain why this topic is interesting and useful to PyMC3 users.
+Explain why this topic is interesting and useful to PyMC users.
 
 ## Related notebooks
 Cover related notebooks on which this notebook will build,

diff --git a/README.rst b/README.rst
@@ -1,17 +1,17 @@
-.. image:: https://cdn.rawgit.com/pymc-devs/pymc3/master/docs/logos/svg/PyMC3_banner.svg
+.. image:: https://cdn.rawgit.com/pymc-devs/pymc/main/docs/logos/svg/PyMC_banner.svg
     :height: 100px
-    :alt: PyMC3 logo
+    :alt: PyMC logo
     :align: center
 
-PyMC3 Examples
+PyMC Examples
 ==============
 
-Supporting examples and tutorials for PyMC3, the Python package for Bayesian statistical modeling and Probabilistic Machine Learning!
+Supporting examples and tutorials for PyMC, the Python package for Bayesian statistical modeling and Probabilistic Machine Learning!
 
 Check out the `getting started guide <http://docs.pymc.io/notebooks/getting_started>`__,  or
-`interact with live examples <https://mybinder.org/v2/gh/pymc-devs/pymc3/master?filepath=%2Fdocs%2Fsource%2Fnotebooks>`__
-using Binder!
-For questions on PyMC3, head on over to our `PyMC Discourse <https://discourse.pymc.io/>`__ forum.
+interact with live examples using Binder! Each notebook in `PyMC examples gallery
+<https://pymc-examples.readthedocs.io>`__ has a binder badge.
+For questions on PyMC, head on over to our `PyMC Discourse <https://discourse.pymc.io/>`__ forum.
 
 Contributing
 ============
@@ -26,15 +26,15 @@ Contact
 
 We are using `discourse.pymc.io <https://discourse.pymc.io/>`__ as our main communication channel. You can also follow us on `Twitter @pymc_devs <https://twitter.com/pymc_devs>`__ for updates and other announcements.
 
-To ask a question regarding modeling or usage of PyMC3 we encourage posting to our Discourse forum under the `“Questions” Category <https://discourse.pymc.io/c/questions>`__. You can also suggest feature in the `“Development” Category <https://discourse.pymc.io/c/development>`__.
+To ask a question regarding modeling or usage of PyMC we encourage posting to our Discourse forum under the `“Questions” Category <https://discourse.pymc.io/c/questions>`__. You can also suggest feature in the `“Development” Category <https://discourse.pymc.io/c/development>`__.
 
 To report an issue, please use the following:
 
--  `PyMC3 Examples - Issue Tracker <https://github.com/pymc-devs/pymc-examples/issues>`__. For
+-  `PyMC Examples - Issue Tracker <https://github.com/pymc-devs/pymc-examples/issues>`__. For
   issues about the example notebooks, errors in the example codes, outdated information, improvement
   suggestions...
--  `PyMC3 - Issue Tracker <https://github.com/pymc-devs/pymc3/issues>`__. For issues, bugs or
-  feature requests related to the PyMC3 library itself.
+-  `PyMC - Issue Tracker <https://github.com/pymc-devs/pymc/issues>`__. For issues, bugs or
+  feature requests related to the PyMC library itself.
 
 Finally, if you need to get in touch for non-technical information about the project, `send us an e-mail <pymc.devs@gmail.com>`__.
 
@@ -46,47 +46,52 @@ If you already know about Bayesian statistics:
 
 
 -  `API quickstart guide <http://docs.pymc.io/notebooks/api_quickstart>`__
--  The `PyMC3 tutorial <http://docs.pymc.io/notebooks/getting_started>`__
--  `PyMC3 examples <https://docs.pymc.io/nb_examples/index.html>`__ and the `API reference <http://docs.pymc.io/api>`__
+-  The `PyMC tutorial <http://docs.pymc.io/notebooks/getting_started>`__
+-  `PyMC examples <https://docs.pymc.io/nb_examples/index.html>`__ and the `API reference <http://docs.pymc.io/api>`__
 
 
 
-Learn Bayesian statistics with a book together with PyMC3:
+Learn Bayesian statistics with a book together with PyMC:
 ----------------------------------------------------------
 
 -  `Probabilistic Programming and Bayesian Methods for Hackers <https://github.com/CamDavidsonPilon/Probabilistic-Programming-and-Bayesian-Methods-for-Hackers>`__ by Cameron Davidson-Pilon: Fantastic book with many applied code examples.
 -  `Doing Bayesian Data Analysis <https://github.com/aloctavodia/Doing_bayesian_data_analysis>`__ by John Kruschke, as well as the `second edition <https://github.com/JWarmenhoven/DBDA-python>`__: Principled introduction to Bayesian data analysis.
--  `Statistical Rethinking: A Bayesian Course with Examples in R and Stan <https://github.com/pymc-devs/resources/tree/master/Rethinking>`__ by Richard McElreath: Comprehensive text on modeling choices and interpretations. 
+-  `Statistical Rethinking: A Bayesian Course with Examples in R and Stan <https://github.com/pymc-devs/resources/tree/master/Rethinking>`__ by Richard McElreath: Comprehensive text on modeling choices and interpretations.
 -  `Bayesian Cognitive Modeling <https://github.com/pymc-devs/resources/tree/master/BCM>`__ by Michael Lee and EJ Wagenmakers: Focused on using Bayesian statistics in cognitive modeling.
 -  `Bayesian Analysis with Python <https://www.packtpub.com/big-data-and-business-intelligence/bayesian-analysis-python-second-edition>`__ (second edition) by Osvaldo Martin: Great introductory book. (`code <https://github.com/aloctavodia/BAP>`__ and errata).
 
-PyMC3 talks
+PyMC talks
 -----------
 
-There are also several talks on PyMC3 which are gathered in this `YouTube playlist <https://www.youtube.com/playlist?list=PL1Ma_1DBbE82OVW8Fz_6Ts1oOeyOAiovy>`__
+There are also several talks on PyMC which are gathered in this `YouTube playlist <https://www.youtube.com/playlist?list=PL1Ma_1DBbE82OVW8Fz_6Ts1oOeyOAiovy>`__
 and as part of `PyMCon 2020 <https://discourse.pymc.io/c/pymcon/2020talks/15>`__
 
 Installation
 ------------
 
-To install PyMC3 on your system, see its `installation section here <https://github.com/pymc-devs/pymc3#installation>`__
+To install PyMC on your system, see its `installation section here <https://docs.pymc.io/en/stable/>`__
 
-Citing PyMC3
+Citing PyMC
 ============
 
-Salvatier J., Wiecki T.V., Fonnesbeck C. (2016) Probabilistic programming
-in Python using PyMC3. PeerJ Computer Science 2:e55
-`DOI: 10.7717/peerj-cs.55 <https://doi.org/10.7717/peerj-cs.55>`__.
+* To cite the PyMC software, use:
 
-Papers citing PyMC3
+  Salvatier J., Wiecki T.V., Fonnesbeck C. (2016) Probabilistic programming
+  in Python using PyMC3. PeerJ Computer Science 2:e55
+  `DOI: 10.7717/peerj-cs.55 <https://doi.org/10.7717/peerj-cs.55>`__.
+
+* To cite specific guides from this collection, use |zenodo|. You'll find page specific
+  citation instructions at the bottom of each page.
+
+Papers citing PyMC
 -------------------
 
 See `Google Scholar <https://scholar.google.de/scholar?oi=bibs&hl=en&authuser=1&cites=6936955228135731011>`__ for a continuously updated list.
 
 Support
 =======
 
-PyMC3 is a non-profit project under NumFOCUS umbrella. If you want to support PyMC3 financially, you can donate `here <https://numfocus.salsalabs.org/donate-to-pymc3/index.html>`__.
+PyMC is a non-profit project under NumFOCUS umbrella. If you want to support PyMC financially, you can donate `here <https://numfocus.salsalabs.org/donate-to-pymc3/index.html>`__.
 
 PyMC for enterprise
 ===================
@@ -107,22 +112,12 @@ Sponsors
 
 |PyMCLabs|
 
-.. |Binder| image:: https://mybinder.org/badge_logo.svg
-   :target: https://mybinder.org/v2/gh/pymc-devs/pymc3/master?filepath=%2Fdocs%2Fsource%2Fnotebooks
-.. |Build Status| image:: https://github.com/pymc-devs/pymc3/workflows/pytest/badge.svg
-   :target: https://github.com/pymc-devs/pymc3/actions
-.. |Coverage| image:: https://codecov.io/gh/pymc-devs/pymc3/branch/master/graph/badge.svg
-  :target: https://codecov.io/gh/pymc-devs/pymc3
-.. |Dockerhub| image:: https://img.shields.io/docker/automated/pymc/pymc3.svg
-  :target: https://hub.docker.com/r/pymc/pymc3
+.. |zenodo| image:: https://zenodo.org/badge/321449673.svg
+   :target: https://zenodo.org/badge/latestdoi/321449673
 .. |NumFOCUS| image:: https://www.numfocus.org/wp-content/uploads/2017/03/1457562110.png
    :target: http://www.numfocus.org/
-.. |NumFOCUS_badge| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
-   :target: http://www.numfocus.org/
 .. |PyMCLabs| image:: https://github.com/pymc-devs/pymc/blob/main/docs/pymc-labs-logo.png
    :target: https://pymc-labs.io
-.. |tidelift| image:: https://img.shields.io/badge/-lifted!-2dd160.svg?colorA=58595b&style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABEAAAAOCAYAAADJ7fe0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAAWJQAAFiUBSVIk8AAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAAAVhJREFUKBV1kj0vBFEUhmd2sdZHh2IlGhKFQuOviEYiNlFodCqtUqPxA%2FwCjUTnDygkGoVERFQaZFlE9nreO%2BdM5u5wkifvuee892Pu3CyEcA0DeIc%2B9IwftJsR6Cko3uCjguZdjuBZhhwmYDjGrOC96WED41UtsgEdGEAPlmAfpuAbFF%2BFZLfoMfRBGzThDtLgePPwBIpdddGzOArhPHUXowbNptE2www6a%2Fm96Y3pHN7oQ1s%2B13pxt1ENaKzBFWyWzaJ%2BRO0C9Jny6VPSoKjLVbMDC5bn5OPuJF%2BBSe95PVEMuugY5AegS9fCh7BedP45hRnj8TC34QQUe9bTZyh2KgvFk2vc8GIlXyTfsvqr6bPpNgv52ynnlomZJNpB70Xhl%2Bf6Sa02p1bApEfnETwxVa%2Faj%2BW%2FFtHltmxS%2FO3krvpTtTnVgu%2F6gvHRFvG78Ef3kOe5PimJXycY74blT5R%2BAAAAAElFTkSuQmCC
-   :target: https://tidelift.com/subscription/pkg/pypi-pymc3?utm_source=pypi-pymc3&utm_medium=referral&utm_campaign=enterprise
 .. |tidelift_learn| image:: https://img.shields.io/badge/-learn%20more-2dd160.svg?color=orange&labelColor=58595b&style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABEAAAAOCAYAAADJ7fe0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAAWJQAAFiUBSVIk8AAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAAAVhJREFUKBV1kj0vBFEUhmd2sdZHh2IlGhKFQuOviEYiNlFodCqtUqPxA%2FwCjUTnDygkGoVERFQaZFlE9nreO%2BdM5u5wkifvuee892Pu3CyEcA0DeIc%2B9IwftJsR6Cko3uCjguZdjuBZhhwmYDjGrOC96WED41UtsgEdGEAPlmAfpuAbFF%2BFZLfoMfRBGzThDtLgePPwBIpdddGzOArhPHUXowbNptE2www6a%2Fm96Y3pHN7oQ1s%2B13pxt1ENaKzBFWyWzaJ%2BRO0C9Jny6VPSoKjLVbMDC5bn5OPuJF%2BBSe95PVEMuugY5AegS9fCh7BedP45hRnj8TC34QQUe9bTZyh2KgvFk2vc8GIlXyTfsvqr6bPpNgv52ynnlomZJNpB70Xhl%2Bf6Sa02p1bApEfnETwxVa%2Faj%2BW%2FFtHltmxS%2FO3krvpTtTnVgu%2F6gvHRFvG78Ef3kOe5PimJXycY74blT5R%2BAAAAAElFTkSuQmCC
    :target: https://tidelift.com/subscription/pkg/pypi-pymc3?utm_source=pypi-pymc3&utm_medium=referral&utm_campaign=enterprise
 .. |tidelift_demo| image:: https://img.shields.io/badge/-request%20a%20demo-2dd160.svg?color=orange&labelColor=58595b&style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABEAAAAOCAYAAADJ7fe0AAAAAXNSR0IArs4c6QAAAAlwSFlzAAAWJQAAFiUBSVIk8AAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDUuNC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KTMInWQAAAVhJREFUKBV1kj0vBFEUhmd2sdZHh2IlGhKFQuOviEYiNlFodCqtUqPxA%2FwCjUTnDygkGoVERFQaZFlE9nreO%2BdM5u5wkifvuee892Pu3CyEcA0DeIc%2B9IwftJsR6Cko3uCjguZdjuBZhhwmYDjGrOC96WED41UtsgEdGEAPlmAfpuAbFF%2BFZLfoMfRBGzThDtLgePPwBIpdddGzOArhPHUXowbNptE2www6a%2Fm96Y3pHN7oQ1s%2B13pxt1ENaKzBFWyWzaJ%2BRO0C9Jny6VPSoKjLVbMDC5bn5OPuJF%2BBSe95PVEMuugY5AegS9fCh7BedP45hRnj8TC34QQUe9bTZyh2KgvFk2vc8GIlXyTfsvqr6bPpNgv52ynnlomZJNpB70Xhl%2Bf6Sa02p1bApEfnETwxVa%2Faj%2BW%2FFtHltmxS%2FO3krvpTtTnVgu%2F6gvHRFvG78Ef3kOe5PimJXycY74blT5R%2BAAAAAElFTkSuQmCC

diff --git a/_static/PyMC3.ico → _static/PyMC.ico b/_static/PyMC3.ico → _static/PyMC.ico
diff --git a/_static/PyMC.png b/_static/PyMC.png
diff --git a/_static/binder.svg b/_static/binder.svg
diff --git a/_static/colab.svg b/_static/colab.svg