Abstractmethod docstrings are not inherited in API reference

[brynpickering]

Description

As is being tracked here, we do not get docstrings in our reference API for abstract methods that are set by child classes, i.e.,

class DiscretionaryTrip(ABC):
    ...
    @abstractmethod
    def choose_destination(self) -> str:
        """Selects a destination for the discretionary activity.

        Returns:
            str: Selected destination zone name.
        """

class DiscretionaryTripOD(DiscretionaryTrip):
    ...
    def choose_destination(self) -> str:
        zone = sample_weighted(self.destination_p)
        area = self._od.labels.destination_zones[zone]

        return area

Python passes the abstract method docstring down to the child class (help(my_discretionary_trip_od_model.choose_destination) will return the expected docstring), but this isn't the case in the docs:

Related links

• https://arup-group.github.io/pam/develop/reference/pam/planner/choice_location/#pam.planner.choice_location.DiscretionaryTripOD.choose_destination

Version

0.2

Proposed change

Repeat docstring in child class methods until mkdocstrings/griffe#96 is fixed.