Add API reference documentation using mkdocstrings #355
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 commit enhances the MkDocs documentation by:
mkdocstrings[python]
to handle auto-generation of API documentation from Python docstrings.mkdocstrings
inmkdocs.yml
under theplugins
section and updating the navigation to include an "API Reference" section.docs/api_reference.md
with directives to generate documentation for key modules and classes insimple_parsing
including:simple_parsing.parsing
simple_parsing.helpers.serialization.serializable.Serializable
simple_parsing.wrappers.dataclass_wrapper
simple_parsing.wrappers.field_wrapper
simple_parsing.ArgumentParser
simple_parsing.helpers.hparams
=1.0
,=7.0
) that were accidentally created in the repository root.The documentation now includes both the examples and a browsable API reference.