Skip to content

Commit

Permalink
Hotfix autodoc not documenting signals and properties
Browse files Browse the repository at this point in the history
Needs a better fix.
  • Loading branch information
igo95862 committed Aug 3, 2022
1 parent a171a2e commit 458a44c
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion src/sdbus/autodoc.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,11 @@

from __future__ import annotations

from typing import Any, Dict
from typing import Any, Dict, List

from sphinx.application import Sphinx
from sphinx.ext.autodoc import AttributeDocumenter, MethodDocumenter
from sphinx.util.docstrings import prepare_docstring

from .dbus_proxy_async_interfaces import DbusInterfaceCommonAsync
from .dbus_proxy_async_method import DbusMethodAsyncBinded
Expand Down Expand Up @@ -79,6 +80,9 @@ def update_annotations(self,

parent.__annotations__[self.object_name] = property_annotation

def get_doc(self) -> List[List[str]]:
return [prepare_docstring(self.object.__doc__)]

def add_content(self,
*args: Any, **kwargs: Any,
) -> None:
Expand Down Expand Up @@ -110,6 +114,9 @@ def update_annotations(self,

parent.__annotations__[self.object_name] = signal_annotation

def get_doc(self) -> List[List[str]]:
return [prepare_docstring(self.object.__doc__)]

def add_content(self,
*args: Any, **kwargs: Any,
) -> None:
Expand Down

0 comments on commit 458a44c

Please sign in to comment.