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
[WIP] Adopt new docspec and integrate with Novella #245
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
…to docspec upgrade)
…eeded` option because it never worked to begin with
…ittests and `DocusaurusRenderer`
…r MarkdownRenderer in @pydoc tag, fetch tags as well
…ssorAction.repeat()` on generated Markdown code
Merged
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.
Goal of this PR is to
@pydoc
tagSinglePageRenderer
interface (or add a new interface) for rendering single docspec objects (instead of only a module)SinglePageRenderer
and it wouldn't make much sense for it to have such a capability)MarkdownRenderer
produce Novella@anchor
tagsCrossRefProcessor
procuce Novella{@link}
tags@pydoc
tag? (If yes, maybe we should include the module name somewhere else in the generated documentation for the module members)Late state considerations:
3.73.8-3.9 compatible? (Currently it is only compatible with 3.10)If you are interested in an introduction to how the new system works, check out the Using Novella guide in the documentation.