acerbilab / pyvbmc

PyVBMC: Variational Bayesian Monte Carlo algorithm for posterior and model inference in Python
https://acerbilab.github.io/pyvbmc/
BSD 3-Clause "New" or "Revised" License
114 stars 6 forks source link

docs: link to source code on GitHub #17

Closed Solosneros closed 3 years ago

Solosneros commented 3 years ago

We decided to add links to the source files of the classes in GitHub to the documentation. This is done using sphinx.ext.linkcode.

We know that this differs from other projects like pytorch that render a page of the source code in the documentation (using sphinx.ext.viewcode. The linkcode has the benefit that one can see the source directly rather than a static html page that is basically a duplicate of the github main branch. (Changing to viewcode is a minor change later. :))