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

speed-up doc building and fix several issues #6781

Merged
merged 5 commits into from
Jun 17, 2023

Conversation

OriolAbril
Copy link
Member

@OriolAbril OriolAbril commented Jun 15, 2023

This PR takes care about multiple doc related things:

  1. Use the READTHEDOCS env var to differenciate local and rtd building processes.
  2. Create a distribution.rst autosummary class for distributions. With that,
    only their .dist method will be documented.
  3. Reorganize part of the api docs for distributions
  4. Fix several sphinx errors with docstrings and pages, missing targets,
    bad formatting...
  5. Update the Makefile and the how to build docs locally page.
  6. Remove some outdated pages and add the docker one to the toctree (until now it was in
    the docs folder but wasn't part of the website navigation.
  7. Some updates to jupyter style guide, some things aren't being used and make
    no sense to keep, others need updating due to changes in the extensions we use.

Also related to #5282 and #5740.

Checklist


📚 Documentation preview 📚: https://pymc--6781.org.readthedocs.build/en/6781/

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov
Copy link

codecov bot commented Jun 15, 2023

Codecov Report

Merging #6781 (4b6b30a) into main (9d24a78) will increase coverage by 1.97%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #6781      +/-   ##
==========================================
+ Coverage   74.06%   76.04%   +1.97%     
==========================================
  Files          95       95              
  Lines       16168    16181      +13     
==========================================
+ Hits        11975    12305     +330     
+ Misses       4193     3876     -317     
Impacted Files Coverage Δ
pymc/distributions/distribution.py 95.15% <ø> (+0.28%) ⬆️
pymc/distributions/mixture.py 66.10% <ø> (+2.09%) ⬆️
pymc/distributions/multivariate.py 53.84% <ø> (+0.43%) ⬆️
pymc/distributions/shape_utils.py 59.59% <ø> (ø)

... and 13 files with indirect coverage changes

@@ -18,7 +18,7 @@ glossary

### Intermediate
- {ref}`pymc_overview` shows PyMC 4.0 code in action
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- {ref}`pymc_overview` shows PyMC 4.0 code in action
- {ref}`pymc_overview` shows PyMC code in action

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This?

@ricardoV94
Copy link
Member

I don't like the Censored / Truncated / Simulator in misc. Do you have a preference for that?

@OriolAbril
Copy link
Member Author

I don't like the Censored / Truncated / Simulator in misc

How is the look now?

@ricardoV94
Copy link
Member

I don't like the Censored / Truncated / Simulator in misc

How is the look now?

Swell!

@OriolAbril
Copy link
Member Author

OriolAbril commented Jun 17, 2023

Great, ready to merge on my end then 😄. I'll try to learn/discover/decide through reviews what is the pymc public API and tackle #5282. Distributions are probably good now, so I'll keep moving top->bottom

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.

DOC: Bad Website Link
2 participants