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

Add examples and/or usage description of autosummary_filename_map #11238

Open
HealthyPear opened this issue Mar 13, 2023 · 1 comment
Open

Add examples and/or usage description of autosummary_filename_map #11238

HealthyPear opened this issue Mar 13, 2023 · 1 comment

Comments

@HealthyPear
Copy link

Is your feature request related to a problem? Please describe.

My problem is essentially described by this comment that I left in the repo of sphinx.automodapi
astropy/sphinx-automodapi#73 (comment)

I am not sure if the issue is fixable upstream (aka here) or there, so I chose to bother everyone :)

I kind of understand what the autosummary_filename_map configuration option does, but it is not clear to me
if it is supposed to fix my problem and how to properly use it.

Describe the solution you'd like

I'd ask at least for some examples in the documentation (perhaps even inspired by my use case and/or the sciki-learn one.

@HealthyPear
Copy link
Author

This might also be related to #1495.

In there the subject is a case in which one has MyClass.my_method() and MyClass.my_Method().

In my case I have instead module.class.my_method() where module is blabla and class is BlaBla.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants