|
2 | 2 | # name: test_render_doc_class[embedded]
|
3 | 3 | '''
|
4 | 4 | # quartodoc.tests.example_class.C { #quartodoc.tests.example_class.C }
|
5 |
| - |
| 5 | + |
6 | 6 | `tests.example_class.C(self, x, y)`
|
7 |
| - |
| 7 | + |
8 | 8 | The short summary.
|
9 |
| - |
| 9 | + |
10 | 10 | The extended summary,
|
11 | 11 | which may be multiple lines.
|
12 |
| - |
| 12 | + |
13 | 13 | ## Parameters
|
14 |
| - |
| 14 | + |
15 | 15 | | Name | Type | Description | Default |
|
16 | 16 | |--------|--------|----------------------|------------|
|
17 | 17 | | `x` | str | Uses signature type. | _required_ |
|
18 | 18 | | `y` | int | Uses manual type. | _required_ |
|
19 |
| - |
| 19 | + |
20 | 20 | ## Attributes
|
21 |
| - |
| 21 | + |
22 | 22 | | Name | Description |
|
23 | 23 | | --- | --- |
|
24 | 24 | | [SOME_ATTRIBUTE](#quartodoc.tests.example_class.C.SOME_ATTRIBUTE) | An attribute |
|
25 | 25 | | [some_property](#quartodoc.tests.example_class.C.some_property) | A property |
|
26 | 26 | | [x](#quartodoc.tests.example_class.C.x) | |
|
27 | 27 | | [y](#quartodoc.tests.example_class.C.y) | |
|
28 | 28 | | [z](#quartodoc.tests.example_class.C.z) | |
|
29 |
| - |
| 29 | + |
30 | 30 | ## Methods
|
31 |
| - |
| 31 | + |
32 | 32 | | Name | Description |
|
33 | 33 | | --- | --- |
|
34 | 34 | | [some_method](#quartodoc.tests.example_class.C.some_method) | A method |
|
35 |
| - |
| 35 | + |
36 | 36 | ### some_method { #quartodoc.tests.example_class.C.some_method }
|
37 |
| - |
| 37 | + |
38 | 38 | `tests.example_class.C.some_method(self)`
|
39 |
| - |
| 39 | + |
40 | 40 | A method
|
41 | 41 | '''
|
42 | 42 | # ---
|
43 | 43 | # name: test_render_doc_class[flat]
|
44 | 44 | '''
|
45 | 45 | # quartodoc.tests.example_class.C { #quartodoc.tests.example_class.C }
|
46 |
| - |
| 46 | + |
47 | 47 | `tests.example_class.C(self, x, y)`
|
48 |
| - |
| 48 | + |
49 | 49 | The short summary.
|
50 |
| - |
| 50 | + |
51 | 51 | The extended summary,
|
52 | 52 | which may be multiple lines.
|
53 |
| - |
| 53 | + |
54 | 54 | ## Parameters
|
55 |
| - |
| 55 | + |
56 | 56 | | Name | Type | Description | Default |
|
57 | 57 | |--------|--------|----------------------|------------|
|
58 | 58 | | `x` | str | Uses signature type. | _required_ |
|
59 | 59 | | `y` | int | Uses manual type. | _required_ |
|
60 |
| - |
| 60 | + |
61 | 61 | ## Attributes
|
62 |
| - |
| 62 | + |
63 | 63 | | Name | Description |
|
64 | 64 | | --- | --- |
|
65 | 65 | | [SOME_ATTRIBUTE](#quartodoc.tests.example_class.C.SOME_ATTRIBUTE) | An attribute |
|
66 | 66 | | [some_property](#quartodoc.tests.example_class.C.some_property) | A property |
|
67 | 67 | | [x](#quartodoc.tests.example_class.C.x) | |
|
68 | 68 | | [y](#quartodoc.tests.example_class.C.y) | |
|
69 | 69 | | [z](#quartodoc.tests.example_class.C.z) | |
|
70 |
| - |
| 70 | + |
71 | 71 | ## Methods
|
72 |
| - |
| 72 | + |
73 | 73 | | Name | Description |
|
74 | 74 | | --- | --- |
|
75 | 75 | | [some_method](#quartodoc.tests.example_class.C.some_method) | A method |
|
76 |
| - |
| 76 | + |
77 | 77 | ## some_method { #quartodoc.tests.example_class.C.some_method }
|
78 |
| - |
| 78 | + |
79 | 79 | `tests.example_class.C.some_method(self)`
|
80 |
| - |
| 80 | + |
81 | 81 | A method
|
82 | 82 | '''
|
83 | 83 | # ---
|
84 | 84 | # name: test_render_doc_class_attributes_section
|
85 | 85 | '''
|
86 | 86 | # quartodoc.tests.example_class.AttributesTable { #quartodoc.tests.example_class.AttributesTable }
|
87 |
| - |
| 87 | + |
88 | 88 | `tests.example_class.AttributesTable(self)`
|
89 |
| - |
| 89 | + |
90 | 90 | The short summary.
|
91 |
| - |
| 91 | + |
92 | 92 | ## Attributes
|
93 |
| - |
| 93 | + |
94 | 94 | | Name | Type | Description |
|
95 | 95 | |--------|--------|---------------------|
|
96 | 96 | | x | str | Uses signature type |
|
|
101 | 101 | # name: test_render_doc_module[embedded]
|
102 | 102 | '''
|
103 | 103 | # quartodoc.tests.example { #quartodoc.tests.example }
|
104 |
| - |
| 104 | + |
105 | 105 | `tests.example`
|
106 |
| - |
| 106 | + |
107 | 107 | A module
|
108 |
| - |
| 108 | + |
109 | 109 | ## Attributes
|
110 |
| - |
| 110 | + |
111 | 111 | | Name | Description |
|
112 | 112 | | --- | --- |
|
113 | 113 | | [a_attr](#quartodoc.tests.example.a_attr) | An attribute |
|
114 |
| - |
| 114 | + |
115 | 115 | ## Classes
|
116 |
| - |
| 116 | + |
117 | 117 | | Name | Description |
|
118 | 118 | | --- | --- |
|
119 | 119 | | [AClass](#quartodoc.tests.example.AClass) | |
|
120 |
| - |
| 120 | + |
121 | 121 | ## Functions
|
122 |
| - |
| 122 | + |
123 | 123 | | Name | Description |
|
124 | 124 | | --- | --- |
|
125 | 125 | | [a_alias](#quartodoc.tests.example.a_alias) | An alias target |
|
126 | 126 | | [a_func](#quartodoc.tests.example.a_func) | A function |
|
127 |
| - |
| 127 | + |
128 | 128 | ### a_alias { #quartodoc.tests.example.a_alias }
|
129 |
| - |
| 129 | + |
130 | 130 | `tests.example.a_alias()`
|
131 |
| - |
| 131 | + |
132 | 132 | An alias target
|
133 |
| - |
| 133 | + |
134 | 134 | ### a_func { #quartodoc.tests.example.a_func }
|
135 |
| - |
| 135 | + |
136 | 136 | `tests.example.a_func()`
|
137 |
| - |
| 137 | + |
138 | 138 | A function
|
139 |
| - |
| 139 | + |
140 | 140 | ### AClass { #quartodoc.tests.example.AClass }
|
141 |
| - |
| 141 | + |
142 | 142 | `tests.example.AClass()`
|
143 | 143 | '''
|
144 | 144 | # ---
|
145 | 145 | # name: test_render_doc_module[flat]
|
146 | 146 | '''
|
147 | 147 | # quartodoc.tests.example { #quartodoc.tests.example }
|
148 |
| - |
| 148 | + |
149 | 149 | `tests.example`
|
150 |
| - |
| 150 | + |
151 | 151 | A module
|
152 |
| - |
| 152 | + |
153 | 153 | ## Attributes
|
154 |
| - |
| 154 | + |
155 | 155 | | Name | Description |
|
156 | 156 | | --- | --- |
|
157 | 157 | | [a_attr](#quartodoc.tests.example.a_attr) | An attribute |
|
158 |
| - |
| 158 | + |
159 | 159 | ## Classes
|
160 |
| - |
| 160 | + |
161 | 161 | | Name | Description |
|
162 | 162 | | --- | --- |
|
163 | 163 | | [AClass](#quartodoc.tests.example.AClass) | |
|
164 |
| - |
| 164 | + |
165 | 165 | ## Functions
|
166 |
| - |
| 166 | + |
167 | 167 | | Name | Description |
|
168 | 168 | | --- | --- |
|
169 | 169 | | [a_alias](#quartodoc.tests.example.a_alias) | An alias target |
|
170 | 170 | | [a_func](#quartodoc.tests.example.a_func) | A function |
|
171 |
| - |
| 171 | + |
172 | 172 | ## a_alias { #quartodoc.tests.example.a_alias }
|
173 |
| - |
| 173 | + |
174 | 174 | `tests.example.a_alias()`
|
175 |
| - |
| 175 | + |
176 | 176 | An alias target
|
177 |
| - |
| 177 | + |
178 | 178 | ## a_func { #quartodoc.tests.example.a_func }
|
179 |
| - |
| 179 | + |
180 | 180 | `tests.example.a_func()`
|
181 |
| - |
| 181 | + |
182 | 182 | A function
|
183 |
| - |
| 183 | + |
184 | 184 | ## AClass { #quartodoc.tests.example.AClass }
|
185 |
| - |
| 185 | + |
186 | 186 | `tests.example.AClass()`
|
187 | 187 | '''
|
188 | 188 | # ---
|
0 commit comments