Extend documentation #10
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
RalfG
requested review from
edeutsch and
mobiusklein
and removed request for
edeutsch
mobiusklein
approved these changes
Nov 11, 2024
| @@ -7,6 +7,8 @@ Python API | |||
| :imported-members: | |||
|
|
|||
|
|
|||
| .. manually documented as parse_annotation is undocumented | |||
There was a problem hiding this comment.
I'll add a cross-reference to the manual documentation here:
:meth:`AnnotationStringParser.__call__`The autodoc sees that it is a function and pulls the signature from AnnotationStringParser.__call__, but nothing else.
There was a problem hiding this comment.
Not entirely following here, but feel free to update
edeutsch
approved these changes
Nov 12, 2024
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.
This PR extends the mzpaf.readthedocs.io website with documentation for the LARK grammar, JSON Schema, regular expressions.
For some sections in the documentation, the Sphinx
conf.pyscript automatically generates some markdown files from JSON files, and copies the railroad diagram. No GitHub actions are required for this, as this code runs on docs-generation at readthedocs.io.The version of the documentation from this branch can be viewed on https://mzpaf.readthedocs.io/en/add-sphinx-docs/.
Edit 11/11/2024: This PR was updated to add upon the existing documentation.