Autodoc fixes #6
Merged
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
…doesn't put code in __init__.py
willronchetti
approved these changes
Aug 11, 2023
| tags: | ||
| - 'v*' | ||
| except: | ||
| - 'v*b*' |
There was a problem hiding this comment.
Do we really not want to push betas automatically?
There was a problem hiding this comment.
Practically, no matter what we might wish, the way this is written it's going to always autodoc master, so a tag on a PR on a branch would not end up having the doc from that branch processed.
But also I think if someone wants beta doc, they can ask for it manually. We rev betas a lot more often than we change doc and I fear it'd be clutter. Worst case, beta doc might appear before it was usable and really confuse people.
dmichaels-harvard
approved these changes
Aug 11, 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.
Also, the doc comes up with useless "Module Content" headings that don't actually ever have content so I'm removing those. You'd have to put stuff in
__init__.pyfor those to be non-empty, and I have no taste for that.