Skip to content

🕷️ The BEST Web Scraping framework that handles everything from a single request to a full-scale crawl! Don't be shy, join here: https://discord.gg/EMgGbDceNQ and follow here for daily tips and tricks: https://x.com/Scrapling_dev

docs: improving the API reference section

Karim shoairb5fdb71b52b6
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 68b6229..c2c5d54 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,5 +1,8 @@
mkdocstrings>=1.0.0
mkdocstrings-python>=2.0.1
+griffe-inherited-docstrings
+griffe-runtime-objects
+griffe-sphinx
mkdocs-material[imaging]>=9.7.1
black>=25.12.0
pngquant
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index 7b5483e..c8b9709 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -127,11 +127,19 @@ plugins:
unwrap_annotated: true
filters:
- '!^_'
+ - "^__"
merge_init_into_class: true
docstring_section_style: spacy
signature_crossrefs: true
show_symbol_type_heading: 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:
homepage: https://scrapling.readthedocs.io/en/latest/