Use AutoAPI for the API documentation #478
Conversation
|
What's your take on potentially removing the closures and just have (bigger) step functions? Almost looks like we would need a class |
Codecov Report
@@ Coverage Diff @@
## main #478 +/- ##
=======================================
Coverage 99.16% 99.16%
=======================================
Files 48 48
Lines 1915 1915
=======================================
Hits 1899 1899
Misses 16 16
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
Closure is pretty huge feature for the functional style of the library, so I would discourage changing this part for having easier doc generation. |
blackjax/mcmc/integrators.py
Outdated
| @@ -49,16 +49,17 @@ def velocity_verlet( | |||
| ) -> EuclideanIntegrator: | |||
| """The velocity Verlet (or Verlet-Störmer) integrator. | |||
|
|
|||
| The velocity Verlet is a two-stage palindromic integrator [1]_ of the form | |||
| The velocity Verlet is a two-stage palindromic integrator [BouRabee2018]_ of the form | |||
There was a problem hiding this comment.
From here on it start to differ than above in terms of reference style ([1]), we should keep it consistent.
There was a problem hiding this comment.
Just saw #493, so we should use explicit ref everywhere right?
There was a problem hiding this comment.
I think we should, it will make #473 easier. I would even change the citation style to follow what Sphinx recommends.
There was a problem hiding this comment.
Let's uniformize all this when solving #493.
rlouf
force-pushed
the
api-doc
branch
2 times, most recently
from
aeb1742 to
8466303
Compare
In this PR I use AutoAPI to build a complete API documentation for Blackjax. We may still need to provide some higher-level information regarding how to use the library, but this is already pretty good out-of-the-box.
My only concern is related to the use of closures in Blackjax, and whether it is possible to write documentation for nested function automatically. We may want to forego the use of closures altogether in the library?