Move to sphinx over doxygen #137
Closed
Conversation
This file contains 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
patrickelectric
force-pushed
the
update-docs
branch
4 times, most recently
from
dce3e69 to
ed45bd0
Compare
ES-Alexander
requested changes
May 10, 2024
There was a problem hiding this comment.
- My understanding was that we were planning to shift to the Material theme for all the Python and C++ docs, and I'm not sure how much that will affect the generation process, so my following comments may not be relevant after that changeover
- Some of the function parameters are being displayed inconsistently
- In several of the
set_*device methods the first parameter is presented differently:
- In the Ping360
control_*methods it seems only the first parameter is being documented, if that
- In several of the
- It's a bit weird / unintuitive that the single-class files need to be clicked through again to get to the actual definitions
- It would be nice if the API files that contain only a single class could be merged with the docs page of that class (e.g. with the description at the top followed by the method docs)
patrickelectric
force-pushed
the
update-docs
branch
2 times, most recently
from
cbb5435 to
55da083
Compare
Signed-off-by: Patrick José Pereira <[email protected]>
Signed-off-by: Patrick José Pereira <[email protected]>
Signed-off-by: Patrick José Pereira <[email protected]>
Signed-off-by: Patrick José Pereira <[email protected]>
Signed-off-by: Patrick José Pereira <[email protected]>
Signed-off-by: Patrick José Pereira <[email protected]>
Signed-off-by: Patrick José Pereira <[email protected]>
patrickelectric
force-pushed
the
update-docs
branch
from
55da083 to
bcce3a0
Compare
|
Check now @ES-Alexander |
|
Thanks for the updates :-) From what I can tell the data generation is all there now, so you've at least mostly fixed my point 2., although I've now noticed there are sometimes some slight inconsistencies in the formatting of the "Returns" values, whereby sometimes the bulletpoints are indented but other times they're not: 
My original points 1. and 3. still stand. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Result visible in: https://patrickelectric.work/ping-python-1/_autosummary/brping.ping1d.Ping1D.html#brping.ping1d.Ping1D
Resolves #136