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.

Sign up for GitHub

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

Jump to bottom

Add member-order and exclude-members to autodoc config #249

Merged
merged 1 commit into from
Oct 16, 2023
Merged

Add member-order and exclude-members to autodoc config #249

merged 1 commit into from
Oct 16, 2023

Conversation

RLKRo
Copy link
Member

@RLKRo RLKRo commented Oct 12, 2023

Description

Add two config options for autodoc:

  1. member-order=bysource: sort entries in API ref by the order of their appearance in the source code. This, among other things, fixes the order of enums:
    image
  2. exclude-members=_abc_impl, model_fields excludes these fields from API ref. I left model_config since it may be useful information.

Checklist

  • I have covered the code with tests
  • I have added comments to my code to help others understand it
  • I have updated the documentation to reflect the changes
  • I have performed a self-review of the changes

@RLKRo RLKRo added the documentation Improvements or additions to documentation label Oct 12, 2023
@RLKRo RLKRo merged commit 8c79188 into dev Oct 16, 2023
17 checks passed
@RLKRo RLKRo deleted the docs/update-autodoc-config branch October 16, 2023 20:34
@RLKRo RLKRo mentioned this pull request Oct 16, 2023
Merged
4 tasks
RLKRo added a commit that referenced this pull request Oct 17, 2023
@RLKRo
Release v0.6.1 (#254)
3e37ae3 
# Release notes

- Add docker profiles (#246)
- Add Context guide (#244)
- Rework basic guide (#209)
- Change documentation build configuration (#250, #249)
- Various documentation updates (#245, #244, #246)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@RLKRo