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

display class members in separate lists w/headings #179

Closed
rdzman opened this issue Apr 17, 2023 · 1 comment
Closed

display class members in separate lists w/headings #179

rdzman opened this issue Apr 17, 2023 · 1 comment

Comments

@rdzman
Copy link
Contributor

rdzman commented Apr 17, 2023

As part of the goal of supplying in-source documentation that looks good and works well with both Sphinx and MATLAB's help and doc commands (see #140), it would be a great improvement if we could display class members in separate lists, e.g. for properties and methods, with corresponding headings, similar to the "Property Summary" and "Method Summary" in the MATLAB doc output.

Currently using the :members: option with the autoclass directive results in a single list (with some sorting options) with no headings.

I like the idea you (@joeced) suggested here of using Jinja templates. That seems like the most flexible approach and could work nicely with the existing :members:.

But, I'm also happy to help work on a much simpler option if there is one. I'm thinking of something like adding :properties: and :methods: options for the autoclass directive. Essentially, duplicating the functionality of :members: and adding filtering to skip over members that are not properties and methods, respectively.

@rdzman
Copy link
Contributor Author

rdzman commented Apr 28, 2023

Resolved with #181. Thanks!

@rdzman rdzman closed this as completed Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant