Merged
Conversation
pressler-vsc
requested review from
bombaci-vsc,
johnstob,
mstewart-vsc and
mtrachy
johnstob
approved these changes
Feb 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds reasonably lightweight doc pages to
jbpy. Because of a desire that they be low maintenance, I wanted to try something other than sphinx and landed on zensical with embedded pdoc (not pdoc3; be wary of the drama) for the auto-API documentation (see their docs for the example I used).Originally, I tried using only pdoc, which worked ok, except I wanted to have something at least somewhat extensible (e.g. for having a page on CLI tools, etc.) and found pdoc limited in that respect.
Note that the rendering of much of the API is still a bit wonky. I chalk much of that up to the haphazard docstrings currently throughout
jbpy. I think a good next step would be to use numpydoc lint and clean those up.Demo
RTD is currently serving this branch from my fork to test the rendering and RTD configuration:
https://jbpy.readthedocs.io/en/latest/