✨ NEW: Nested parse class docstrings

Author: chrisjsewell

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.1.1 (November 2021)
+
+✨ NEW: Nested parse class docstrings
+
 ## v0.1.0 (November 2021)
 
 Initial release.

docs/example/models.py

@@ -5,7 +5,7 @@
 
 
 class User(Base):
-    """A user."""
+    """A ``user``."""
 
     __tablename__ = "dbusers"
     __table_args__ = (UniqueConstraint("first_name", "last_name"),)

sphinx_sqlalchemy/__init__.py

@@ -1,7 +1,7 @@
 """Sphinx extension for documenting SQLAlchemy ORMs"""
 from typing import TYPE_CHECKING
 
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 
 if TYPE_CHECKING:
     from sphinx.application import Sphinx

sphinx_sqlalchemy/main.py

@@ -2,6 +2,7 @@
 from typing import List, Optional, Set
 
 from docutils import nodes
+from docutils.statemachine import StringList
 
 # from docutils.parsers.rst import directives
 from sphinx.application import Sphinx
@@ -93,7 +94,11 @@ def add_content(self, mapper: Mapper, definition: nodes.definition) -> None:
 
         # class documentation
         if mapper.class_.__doc__:
-            definition += nodes.paragraph(text=f"{mapper.class_.__doc__}")
+            self.state.nested_parse(
+                StringList(mapper.class_.__doc__.splitlines()),
+                self.content_offset,
+                definition,
+            )
 
         # column documentation
         if mapper.columns: