Skip to content

Commit b5fdb71

Browse files
committed
docs: improving the API reference section
1 parent 4947152 commit b5fdb71

2 files changed

Lines changed: 11 additions & 0 deletions

File tree

docs/requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
mkdocstrings>=1.0.0
22
mkdocstrings-python>=2.0.1
3+
griffe-inherited-docstrings
4+
griffe-runtime-objects
5+
griffe-sphinx
36
mkdocs-material[imaging]>=9.7.1
47
black>=25.12.0
58
pngquant

mkdocs.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,11 +127,19 @@ plugins:
127127
unwrap_annotated: true
128128
filters:
129129
- '!^_'
130+
- "^__"
130131
merge_init_into_class: true
131132
docstring_section_style: spacy
132133
signature_crossrefs: true
133134
show_symbol_type_heading: true
134135
show_symbol_type_toc: true
136+
show_inheritance_diagram: true
137+
modernize_annotations: true
138+
extensions:
139+
- griffe_runtime_objects
140+
- griffe_sphinx
141+
- griffe_inherited_docstrings:
142+
merge: true
135143

136144
extra:
137145
homepage: https://scrapling.readthedocs.io/en/latest/

0 commit comments

Comments
 (0)