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

Do not sort API docs in alphabetical order #108

Closed
ddundo opened this issue Jan 12, 2025 · 0 comments · Fixed by #109
Closed

Do not sort API docs in alphabetical order #108

ddundo opened this issue Jan 12, 2025 · 0 comments · Fixed by #109
Assignees
@ddundo
Labels
clarity Something isn't sufficiently clear

Comments

@ddundo
Copy link
Member

ddundo commented Jan 12, 2025 •
edited
Loading

While reviewing mesh-adaptation/movement#114 I noticed that classes in movement.monitor are in alphabetical order in the API, which hindered readability in my opinion. To sort them in the order as we wrote them in, we just need to add autodoc_member_order = 'bysource' in conf.py
@ddundo ddundo self-assigned this Jan 12, 2025
@ddundo ddundo added the clarity Something isn't sufficiently clear label Jan 12, 2025
ddundo added a commit that referenced this issue Jan 12, 2025
@ddundo
Order members by module's source
6803e09 
Closes #108.
@ddundo ddundo mentioned this issue Jan 12, 2025
Merged
@jwallwork23 jwallwork23 moved this from Backlog to Ready for review in Mesh Adaptation development board Jan 13, 2025
@ddundo ddundo closed this as completed in b0f4a33 Jan 13, 2025
@github-project-automation github-project-automation bot moved this from Ready for review to Done in Mesh Adaptation development board Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ddundo ddundo

Labels
clarity Something isn't sufficiently clear
Projects
Mesh Adaptation development board
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Order members by module's source mesh-adaptation/docs
1 participant
@ddundo