Implement Octopoes Models documentation #2858
Merged
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.
Changes
This implementation uses
autodoc-pydantic
to enable listing of Octopoes Models in the documentation. The goal for now was to list the models and their fields, without navigating the codebase. The models and their fields still have to be documented properly. I've also updatedsettings-doc
.I've also explored the possibility of using
autodoc-pydantic
to replacesettings-doc
, the utility we currently use for environment settings documentation. But it seemed unsuitable for this purpose. It could however be used to generate an API reference for the settings objects, but not directly for generating documentation about the environment settings (yet).I'm currently also compiling and looking into additional ideas, such as a graph overview of the models and their relationship.
Issue link
Closes #2622
Closes #2797
Demo
Code Checklist
Communication
.env
changes files if required and changed the.env-dist
accordingly.Checklist for code reviewers:
Copy-paste the checklist from the docs/source/templates folder into your comment.
Checklist for QA:
Copy-paste the checklist from the docs/source/templates folder into your comment.