Skip to content

Commit dd7e3fc

Browse files
committed
downgrade headings
1 parent 49e5ab1 commit dd7e3fc

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/haystack_pydoc_tools/renderers.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,16 @@ class DocusaurusRenderer(Renderer):
238238
markdown: MarkdownRenderer = dataclasses.field(default_factory=MarkdownRenderer)
239239

240240
def init(self, context: Context) -> None:
241+
# Set fixed header levels for Docusaurus (downgrade all headings by +1)
242+
# This ensures Module starts at h2, Class at h3, Method/Function at h4
243+
self.markdown.use_fixed_header_levels = True
244+
self.markdown.header_level_by_type = {
245+
"Module": 2,
246+
"Class": 3,
247+
"Method": 4,
248+
"Function": 4,
249+
"Data": 4,
250+
}
241251
self.markdown.init(context)
242252

243253
def render(self, modules: t.List[docspec.Module]) -> None:

0 commit comments

Comments
 (0)