Skip to content

Commit 4352045

Browse files
committed
fix(renderer): put each relevant object in its own section (e.g. classes, methods)
1 parent b61913b commit 4352045

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

quartodoc/renderers/md_renderer.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ def render(self, el: layout.Doc):
249249
def render(self, el: Union[layout.DocClass, layout.DocModule]):
250250
title = self.render_header(el)
251251

252-
extra_parts = []
252+
attr_docs = []
253253
meth_docs = []
254254
class_docs = []
255255

@@ -276,18 +276,18 @@ def render(self, el: Union[layout.DocClass, layout.DocModule]):
276276

277277
_attrs_table = "\n".join(map(self.summarize, raw_attrs))
278278
attrs = f"{sub_header} Attributes\n\n{header}\n{_attrs_table}"
279-
extra_parts.append(attrs)
279+
attr_docs.append(attrs)
280280

281281
# classes summary table ----
282282
if raw_classes:
283283
_summary_table = "\n".join(map(self.summarize, raw_classes))
284284
section_name = "Classes"
285285
objs = f"{sub_header} {section_name}\n\n{header}\n{_summary_table}"
286-
extra_parts.append(objs)
286+
class_docs.append(objs)
287287

288288
n_incr = 1 if el.flat else 2
289289
with self._increment_header(n_incr):
290-
class_docs = [self.render(x) for x in raw_classes if isinstance(x, layout.Doc)]
290+
class_docs.extend([self.render(x) for x in raw_classes if isinstance(x, layout.Doc)])
291291

292292
# method summary table ----
293293
if raw_meths:
@@ -297,15 +297,15 @@ def render(self, el: Union[layout.DocClass, layout.DocModule]):
297297
else "Functions"
298298
)
299299
objs = f"{sub_header} {section_name}\n\n{header}\n{_summary_table}"
300-
extra_parts.append(objs)
300+
meth_docs.append(objs)
301301

302302
# TODO use context manager, or context variable?
303303
n_incr = 1 if el.flat else 2
304304
with self._increment_header(n_incr):
305-
meth_docs = [self.render(x) for x in raw_meths if isinstance(x, layout.Doc)]
305+
meth_docs.extend([self.render(x) for x in raw_meths if isinstance(x, layout.Doc)])
306306

307307
body = self.render(el.obj)
308-
return "\n\n".join([title, body, *extra_parts, *meth_docs, *class_docs])
308+
return "\n\n".join([title, body, *attr_docs, *class_docs, *meth_docs])
309309

310310
@dispatch
311311
def render(self, el: layout.DocFunction):

0 commit comments

Comments
 (0)