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

Support autodoc_class_signature #20

Open
DatGuy1 opened this issue Mar 12, 2023 · 1 comment
Open

Support autodoc_class_signature #20

DatGuy1 opened this issue Mar 12, 2023 · 1 comment

Comments

@DatGuy1
Copy link

DatGuy1 commented Mar 12, 2023

autodoc_class_signature

This value selects how the signature will be displayed for the class defined by autoclass directive. The possible values are:

"mixed"
Display the signature with the class name.

"separated"
Display the signature as a method.

The default is "mixed".
@chrisjsewell
Copy link
Member

sphinx-autodoc2/src/autodoc2/render/rst_.py

Line 58 in 13933a5

# TODO get signature (for functions, etc), plus sphinx also runs rst.escape

😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@chrisjsewell @DatGuy1