From b5fdb71b52b6a74710097046730b280ee07f6854 Mon Sep 17 00:00:00 2001 From: Karim shoair Date: Thu, 1 Jan 2026 21:07:20 +0200 Subject: [PATCH] docs: improving the API reference section --- docs/requirements.txt | 3 +++ mkdocs.yml | 8 ++++++++ 2 files changed, 11 insertions(+) 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/