-
Notifications
You must be signed in to change notification settings - Fork 53
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
Various improvements to documentation infrastructure #354
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #354 +/- ##
=======================================
Coverage 79.98% 79.98%
=======================================
Files 21 21
Lines 1634 1634
=======================================
Hits 1307 1307
Misses 327 327 ☔ View full report in Codecov by Sentry. |
Still needs some work. I'll fix the copybutton and preview action. Do you want me to also add commonly referred libraries to intersphinx and start using more cross-references? Is there a page that come to mind that would be a candidate to serve as kind of example/template on how to use it? |
In terms of the cross-references, I think this is most useful in the API pages. An example would be the For example the |
Should be ready to merge now |
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.
Thanks @OriolAbril!
Multiple changes related to documentation infrastructure.
Can add some more depending on preferences.
Add conda forge install instructions
add viewcode and copybutton extensions. They add the [source] link to docs and a copybutton to
copy whole cells. I will double check, but using the copy button should also copy the snippets
in docstrings like the one in https://causalpy.readthedocs.io/en/latest/api_skl_experiments.html
without the >>> parts.
Add the rtd-preview workflow that adds a link to the PR documentation preview as text at the
bottom of the PR description. From what I see, PR doc preview aren't active yet, this can
be done from https://readthedocs.org/dashboard/causalpy/edit/, scroll down and check
the
remove sphinx-design from [docs] external dependencies as it was not used
updates to rtd config to make it more future proof
Related to #236 (not completely sure about the scope of the issue so not sure if it should be closed already or not yet), closes #86