-
Notifications
You must be signed in to change notification settings - Fork 66
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
Change docs theme #371
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
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 |
Thanks @OriolAbril. If you think this is good to go, could you approve in a review so I can merge? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Go 🚀 !
pydata_sphinx_theme
. So this now matches with bothpymc
andpymc-marketing
repos.pymc-marketing
repo #369Worth checking the API docs. For example, the API docs for the class
LinearRegression
(inpymc_model.py
) includes a LOT of stuff because we inherit fromModelBuilder
which in turn inherits frompm.Model
. Not saying we don't, but do we want all that stuff?📚 Documentation preview 📚: https://causalpy--371.org.readthedocs.build/en/371/