Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

api docs template #5266

Merged
merged 4 commits into from
Dec 18, 2021
Merged

Conversation

OriolAbril
Copy link
Member

I have modified the API docs for the distributions subsection so it can serve as
a template to update the rest of the modules (both present and missing, I haven't checked
if there are important functions missing from the api docs).

Key points:

  • make sure that objects are documented at the path we want users to import them from.
    Users will do pymc.Normal, not pymc.distributions.continuous.Normal so the class
    should be documented as pymc.Normal
  • Use autosummary with :toctree: option instead of automodule. This is more personal preference,
    but I think it looks better if each object has its own page. It is still easy to navigate between
    objects because they are all listed in the left sidebar.
  • Make sure docs are working properly. The transform module is not rendering right,
    not really know why but sphinx doesn't like it and refuses to see pymc.transforms as a module,
    any ideas?

@codecov
Copy link

codecov bot commented Dec 16, 2021

Codecov Report

Merging #5266 (10e32df) into main (95bd5e5) will increase coverage by 0.23%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #5266      +/-   ##
==========================================
+ Coverage   78.94%   79.18%   +0.23%     
==========================================
  Files          88       88              
  Lines       14237    14353     +116     
==========================================
+ Hits        11240    11366     +126     
+ Misses       2997     2987      -10     
Impacted Files Coverage Δ
pymc/model.py 83.26% <ø> (-0.05%) ⬇️
pymc/distributions/transforms.py 92.55% <100.00%> (+0.59%) ⬆️
pymc/backends/report.py 89.51% <0.00%> (-2.10%) ⬇️
pymc/distributions/dist_math.py 86.78% <0.00%> (-0.92%) ⬇️
pymc/gp/gp.py 93.18% <0.00%> (-0.43%) ⬇️
pymc/__init__.py 96.00% <0.00%> (-0.08%) ⬇️
pymc/backends/arviz.py 89.51% <0.00%> (-0.05%) ⬇️
pymc/sampling_jax.py 0.00% <0.00%> (ø)
pymc/initial_point.py 100.00% <0.00%> (ø)
... and 7 more

@michaelosthege michaelosthege merged commit c009717 into pymc-devs:main Dec 18, 2021
@OriolAbril OriolAbril deleted the api_docs_template branch December 18, 2021 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants