Commit 2f8f2b7
committed
feat(docs): improve mkdocstrings configuration
Enhance Python documentation generation with updated mkdocstrings settings.
This commit:
- Enables `dataclasses`, `unpack_typeddict`, and `griffe_fieldz` extensions for richer API documentation.
- Sets member filters to `public` for clearer visibility of exposed APIs.
- Introduces `overloads_only`, `show_signature_type_parameters`, `parameter_headings`, and `type_parameter_headings` for more precise and structured signature and parameter display.
- Removes the `docstring_inheritance.griffe` extension due to a reported crash.
- Activates `skip_local_inventory` for potential build performance improvements.1 parent 64558e4 commit 2f8f2b7
1 file changed
Lines changed: 11 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
165 | 165 | | |
166 | 166 | | |
167 | 167 | | |
168 | | - | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
169 | 172 | | |
170 | 173 | | |
171 | 174 | | |
172 | 175 | | |
173 | 176 | | |
174 | | - | |
| 177 | + | |
175 | 178 | | |
176 | 179 | | |
177 | 180 | | |
178 | 181 | | |
179 | 182 | | |
180 | 183 | | |
| 184 | + | |
181 | 185 | | |
182 | 186 | | |
| 187 | + | |
183 | 188 | | |
184 | 189 | | |
185 | 190 | | |
| 191 | + | |
186 | 192 | | |
187 | 193 | | |
188 | | - | |
189 | | - | |
190 | | - | |
191 | | - | |
| 194 | + | |
192 | 195 | | |
193 | 196 | | |
194 | 197 | | |
| |||
201 | 204 | | |
202 | 205 | | |
203 | 206 | | |
| 207 | + | |
204 | 208 | | |
| 209 | + | |
205 | 210 | | |
206 | | - | |
207 | 211 | | |
208 | 212 | | |
209 | 213 | | |
| |||
0 commit comments