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

Summary list of class methods and properties in docs? #3809

Open
dragorosson opened this issue Jan 16, 2023 · 1 comment
Open

Summary list of class methods and properties in docs? #3809

dragorosson opened this issue Jan 16, 2023 · 1 comment

Comments

@dragorosson
Copy link

Even though I'm developing in C#, I am mostly using the C++ docs to understand the TileDB Embedded API because (understandably) it has the most filled-out method summaries. However, it can be time-consuming to find methods that might do what I'm looking for because I don't see a concise list of them anywhere. Instead, I have to scroll through the full documentation for a class, including the method summaries, examples, parameters, and return values.

Compare this to https://learn.microsoft.com/en-us/dotnet/api/system.array?view=net-7.0, which has a sidebar with expandable properties and methods sections.

Could something similar be enabled for the readthedocs-based documentation?

P.S. The existing docs have been very helpful and I'm glad that they're there!

@ihnorton
Copy link
Member

Hi @dragorosson, this does not seem to be supported at the moment by the doxygen->sphinx/rtd tool we use (Breathe). There is a related tool called Exhale that I've looked at in the past which appears to provide this capability. I'll have to look at it again in more detail to see; we will definitely keep this in mind as we are reworking our docs. Thanks for the suggestion.

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

2 participants