Move pyrealm_build_data
documentation into an autodoc style setup
#331
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.
Description
This PR moves all of the text out of the existing
pyrealm_build_data.md
file and into appropriate__init__.py
docstrings within thepyrealm_build_data
package. It then addsautodoc
directives to pull those docstrings back into the same file. This keeps the package documentation actually within the package.The PR also removes a couple of outdated files and adds some missing documentation.
Fixes #271
Type of change
Key checklist
pre-commit
checks:$ pre-commit run -a
$ poetry run pytest
Further checks