subpages in the doc #278
Merged
subpages in the doc #278
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
|
|
WOW @philippemiron !!! |
|
It looks awesome. |
|
I think we should be able to create a special |
milancurcic
approved these changes
Sep 22, 2023
There was a problem hiding this comment.
Awesome, thank you. Two critical warnings had to do with wavelet.py docstrings formatting. They're gone now. The remaining warnings don't seem two concerning to me, they all seem to have to do with double definition of functions, one of them being autogenerated by Sphinx. Let's figure out where to put chunk diagram in a future PR. I built and tested the docs locally and the autosummaries work and look great.
|
What else need to be done to merge this? |
|
@philippemiron please merge if ready. |
philippemiron
added a commit
to philippemiron/clouddrift
that referenced
this pull request
Nov 16, 2023
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.
I played (way too long..) with autosummary this evening. It does generate a doc similar to
scipymuch easier to browse. Only thing I haven't try yet to include the figure afterchunk.There are also a lot of warnings when building the docs and I believe it's due to the way we import in
__init__.pythat conflicts with the::recursive::option.