docs: improving the API reference section
This commit is contained in:
@@ -1,5 +1,8 @@
|
|||||||
mkdocstrings>=1.0.0
|
mkdocstrings>=1.0.0
|
||||||
mkdocstrings-python>=2.0.1
|
mkdocstrings-python>=2.0.1
|
||||||
|
griffe-inherited-docstrings
|
||||||
|
griffe-runtime-objects
|
||||||
|
griffe-sphinx
|
||||||
mkdocs-material[imaging]>=9.7.1
|
mkdocs-material[imaging]>=9.7.1
|
||||||
black>=25.12.0
|
black>=25.12.0
|
||||||
pngquant
|
pngquant
|
||||||
@@ -127,11 +127,19 @@ plugins:
|
|||||||
unwrap_annotated: true
|
unwrap_annotated: true
|
||||||
filters:
|
filters:
|
||||||
- '!^_'
|
- '!^_'
|
||||||
|
- "^__"
|
||||||
merge_init_into_class: true
|
merge_init_into_class: true
|
||||||
docstring_section_style: spacy
|
docstring_section_style: spacy
|
||||||
signature_crossrefs: true
|
signature_crossrefs: true
|
||||||
show_symbol_type_heading: true
|
show_symbol_type_heading: true
|
||||||
show_symbol_type_toc: true
|
show_symbol_type_toc: true
|
||||||
|
show_inheritance_diagram: true
|
||||||
|
modernize_annotations: true
|
||||||
|
extensions:
|
||||||
|
- griffe_runtime_objects
|
||||||
|
- griffe_sphinx
|
||||||
|
- griffe_inherited_docstrings:
|
||||||
|
merge: true
|
||||||
|
|
||||||
extra:
|
extra:
|
||||||
homepage: https://scrapling.readthedocs.io/en/latest/
|
homepage: https://scrapling.readthedocs.io/en/latest/
|
||||||
|
|||||||
Reference in New Issue
Block a user