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

Change docs theme #371

Merged
merged 6 commits into from
Jun 26, 2024
Merged

Change docs theme #371

merged 6 commits into from
Jun 26, 2024

Conversation

drbenvincent
Copy link
Collaborator

@drbenvincent drbenvincent commented Jun 25, 2024

Worth checking the API docs. For example, the API docs for the class LinearRegression (in pymc_model.py) includes a LOT of stuff because we inherit from ModelBuilder which in turn inherits from pm.Model. Not saying we don't, but do we want all that stuff?


📚 Documentation preview 📚: https://causalpy--371.org.readthedocs.build/en/371/

@drbenvincent drbenvincent requested a review from OriolAbril June 25, 2024 15:15
Copy link

codecov bot commented Jun 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.60%. Comparing base (f659908) to head (f513ef8).
Report is 110 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #371   +/-   ##
=======================================
  Coverage   85.60%   85.60%           
=======================================
  Files          22       22           
  Lines        1716     1716           
=======================================
  Hits         1469     1469           
  Misses        247      247           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@OriolAbril
Copy link
Contributor

Worth checking the API docs. For example, the API docs for the class LinearRegression (in pymc_model.py) includes a LOT of stuff because we inherit from ModelBuilder which in turn inherits from pm.Model. Not saying we don't, but do we want all that stuff?

It is probably enough for many of them to mention the parent class and link to its docs (which should have those methods). That being said, the approach initially taken for pymc-marketing was to automate completely the generation of API docs. I think it would be possible to modify the template so inherited methods are not shown, but given the templates are only type specific (class/method/module) customization of the hierarchy or content depending on the module or class will end up complicating things more than generating all the rst/markdown files once and update them whenever a new object is added/removed to the library.

Everything else looks good, but at some point (especially if a pymc-analytics is created) it might help to externalize the common customizations into a labs theme

@drbenvincent
Copy link
Collaborator Author

Thanks @OriolAbril. If you think this is good to go, could you approve in a review so I can merge?

Copy link
Collaborator

@juanitorduz juanitorduz left a comment

Choose a reason for hiding this comment

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

Go 🚀 !

@drbenvincent drbenvincent merged commit f6fd97c into main Jun 26, 2024
8 checks passed
@drbenvincent drbenvincent deleted the theme-change branch June 26, 2024 11:40
@drbenvincent drbenvincent added the documentation Improvements or additions to documentation label Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Harmonise docs theme with pymc-marketing repo Restructure the API section of the docs
3 participants