-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Closed
Labels
extensions:autodochelp wantedtype:enhancementenhance or introduce a new featureenhance or introduce a new feature
Description
Let's say I have the following two classes
# -*- coding: utf-8 -*
import abc
class Superclass(object):
"""The one to rule them all"""
@abc.abstractmethod
def give(self, ring):
"""Give out a ring"""
pass
class Derived(Superclass):
"""Somebody has to do the work"""
def give(self, ring):
print("I pass the ring {} to you".format(ring))Is it possible to instruct Sphinx (or even better sphinx-apidoc) to use the docstring of Superclass.give(...) for Derived.give(...) without copying it manually?
The Help widget of Spyder IDE does something similar but as far as I understand, fetching the parent's docstring is not handled by Sphinx there.
pawamoy and tgsmith61591
Metadata
Metadata
Assignees
Labels
extensions:autodochelp wantedtype:enhancementenhance or introduce a new featureenhance or introduce a new feature