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

Feature request: option to set ":nosignatures:" for autosummary #43

Closed
dgilland opened this issue Mar 23, 2021 · 5 comments
Closed

Feature request: option to set ":nosignatures:" for autosummary #43

dgilland opened this issue Mar 23, 2021 · 5 comments

Comments

@dgilland
Copy link
Contributor

Would be useful to be able to specify the :nosignatures: option for the autosummary to disable exception/class/function signatures. I'm currently resorting to monkey-patching AutosummaryDocumenter.add_autosummary to inline the option globally.

@Chilipp
Copy link
Owner

Chilipp commented Apr 15, 2021

Hey @dgilland! Sounds like a good approach to me! Sorry for getting back to you so late, it took a while to find some time for me to become up-to-date with the latest developments in sphinx. I just released a new version that is compatible with sphinx 3.4 and 3.5.

Would you be willing to provide a PR to add the :nosignatures: option?

@dgilland
Copy link
Contributor Author

@Chilipp I've opened a PR to add this: #46

Chilipp added a commit that referenced this issue Apr 16, 2021
GH-43: Add support for autosummary-nosignatures option.
@ycremar
Copy link

ycremar commented Apr 16, 2021

Thank you @dgilland and @Chilipp for the new feature. It works great! I was just looking for solutions and found it updated here. I wonder if the new feature is updated on PyPI cuz directly installing it from pip seems not working (but pip install git+ from this repo works).

@Chilipp
Copy link
Owner

Chilipp commented Apr 17, 2021

Hey @ycremar ! I'll make a new release asap. There is an issue with the docs on RTD and I'll first need to figure how to fix this.

https://readthedocs.org/projects/autodocsumm/builds/13526310/

@Chilipp
Copy link
Owner

Chilipp commented Apr 17, 2021

Closed via #46. The issue with the docs is tracked in #47

@Chilipp Chilipp closed this as completed Apr 17, 2021
This issue was closed.
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

3 participants