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

python bases in packages - follow up on #4944 #9664

Closed
Bibo-Joshi opened this issue Sep 22, 2021 · 1 comment
Closed

python bases in packages - follow up on #4944 #9664

Bibo-Joshi opened this issue Sep 22, 2021 · 1 comment

Comments

@Bibo-Joshi
Copy link
Contributor

@Bibo-Joshi Bibo-Joshi commented Sep 22, 2021

Is your feature request related to a problem? Please describe.
Same problem as described in #4944

Describe the solution you'd like
sphinx checks if the base class is documented somewhere. If yes, it inserts the reference to the corresponding page automatically.

Describe alternatives you've considered
As originally proposed in #3104, allow autodoc-process-signature to return a list of strings that will be appended to Bases:

Additional context
#4944 was marked as closed by #9233, but that PR unfortunately doesn't solve the problem: While I now can return a different base class, I still can't control the text of the hyperlink for that class.
With autodoc-process-signature being allowed to return strings, one could just return something like ':class:`telegram.TelegramObject`'

PS: maybe we can just reopen #4944 and continue discussion there …

tk0miya added a commit to tk0miya/sphinx that referenced this issue Sep 23, 2021
…nippet

This allows to inject a reST snippet through autodoc-process-bases
event.  It helps to modify the base classes of any class to the expected
mark-up'ed text by custom extension.
@tk0miya tk0miya added this to the 4.3.0 milestone Sep 23, 2021
@tk0miya
Copy link
Member

@tk0miya tk0miya commented Sep 23, 2021

I posted #9665. Could you check it please?

@tk0miya tk0miya closed this in d13b86e Sep 25, 2021
tk0miya added a commit that referenced this issue Sep 25, 2021
…ction

Close #9664: autodoc: autodoc-process-bases supports reST snippet
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 26, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants