Skip to content
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

Implement Octopoes Models documentation #2858

Merged
merged 8 commits into from
Apr 26, 2024

Conversation

ammar92
Copy link
Contributor

@ammar92 ammar92 commented Apr 17, 2024

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 updated settings-doc.

I've also explored the possibility of using autodoc-pydantic to replace settings-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

image

Code Checklist

  • All the commits in this PR are properly PGP-signed and verified.
  • This PR only contains functionality relevant to the issue; tickets have been created for newly discovered issues.
  • I have written unit tests for the changes or fixes I made.
  • For any non-trivial functionality, I have added integration and/or end-to-end tests.
  • I have performed a self-review of my code and refactored it to the best of my abilities.

Communication

  • I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
  • I have made corresponding changes to the documentation, if necessary.
  • I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

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.

@ammar92 ammar92 added the documentation Improvements or additions to documentation label Apr 17, 2024
@ammar92 ammar92 marked this pull request as ready for review April 17, 2024 08:43
@ammar92 ammar92 requested a review from a team as a code owner April 17, 2024 08:43
@noamblitz
Copy link
Contributor

This is great @ammar92

@underdarknl underdarknl merged commit cbd8bd9 into main Apr 26, 2024
7 checks passed
@underdarknl underdarknl deleted the feature/implement-autodoc-pydantic branch April 26, 2024 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for Octopoes Objects
3 participants