File tree Expand file tree Collapse file tree 2 files changed +29
-2
lines changed Expand file tree Collapse file tree 2 files changed +29
-2
lines changed Original file line number Diff line number Diff line change @@ -95,10 +95,36 @@ quartodoc:
95
95
# set the children option, so that methods get documented
96
96
# on separate pages. MdRenderer's docs will include a summary
97
97
# table that links to each page.
98
- - name: quartodoc. MdRenderer
98
+ - name: MdRenderer
99
99
children: separate
100
100
` ` `
101
101
102
+ # # Reference page sub-sections
103
+
104
+ quartodoc supports two levels of grouping on the reference page.
105
+ Use the `subtitle:` option to add an additional level of grouping.
106
+
107
+ For example, the code below creates an API reference page with one top-level section ("Some section"),
108
+ with two sub-sections inside it.
109
+
110
+
111
+ ` ` ` yaml
112
+ quartodoc:
113
+ package: quartodoc
114
+ sections:
115
+ - title: Some section
116
+
117
+ - subtitle: Stuff A
118
+ desc: This is subsection A
119
+ contents:
120
+ - MdRenderer
121
+
122
+ - subtitle: Stuff B
123
+ desc: This is subsection B
124
+ contents:
125
+ - get_object
126
+ ` ` `
127
+
102
128
# # Grouping on a page
103
129
104
130
By default, content in each section gets included in the same index table,
Original file line number Diff line number Diff line change @@ -46,9 +46,10 @@ print(renderer.render(doc_params))
46
46
47
47
The `sections` field defines which functions to document.
48
48
49
- It requires three pieces of configuration :
49
+ It commonly requires three pieces of configuration :
50
50
51
51
* `title`: a title for the section
52
52
* `desc`: a description for the section
53
53
* `contents`: a list of functions to document
54
54
55
+ You can also replace `title` with `subtitle` to create a sub-section.
You can’t perform that action at this time.
0 commit comments