Skip to content

Commit 378ac31

Browse files
Adjusted settings to include submodules (#3757)
* Adjusted settings to include submodules * Update copyright --------- Co-authored-by: Michael Schuster <[email protected]>
1 parent 614df19 commit 378ac31

File tree

2 files changed

+32
-6
lines changed

2 files changed

+32
-6
lines changed

docs/mkdocs.yml

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,41 @@ plugins:
2121
python:
2222
setup_commands:
2323
- import docs.sys_modules_mock
24-
rendering:
24+
options:
25+
# Include all public members, not just those in __all__
26+
members: true
27+
inherited_members: false
28+
# Show all submodules automatically
29+
show_submodules: true
30+
# Include functions, classes, modules, attributes
31+
docstring_style: google
32+
# Selection options
33+
filters:
34+
- "!^_" # Exclude private members (starting with _)
35+
- "^__init__$" # But include __init__ methods
36+
- "^__new__$" # And __new__ methods
37+
# Rendering options
2538
show_source: true
39+
show_root_heading: true
40+
show_root_toc_entry: true
41+
show_object_full_path: false
42+
show_category_heading: true
43+
# Group members by category
44+
group_by_category: true
45+
# Show type annotations
46+
show_signature_annotations: true
47+
# Show return type annotations
48+
show_return_annotations: true
49+
# Show the bases of classes
50+
show_bases: true
51+
# Merge init method documentation into class docstring
52+
merge_init_into_class: true
2653

2754
# This setting ensures links don't use directory URLs
2855
use_directory_urls: false
2956

3057
copyright: >
31-
Copyright &copy; 2022 ZenML GmbH –
58+
Copyright &copy; 2025 ZenML GmbH –
3259
<a href="#__consent">Change cookie settings</a>
3360
3461
extra:

docs/mkdocstrings_helper.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,10 @@ def create_entity_docs(
9999
module_md = (
100100
f"# {item_name}\n\n"
101101
f"::: {zenml_import_path}.{item.stem}\n"
102-
f" handler: python\n"
103-
f" rendering:\n"
102+
f" options:\n"
104103
f" show_root_heading: true\n"
105104
f" show_source: true\n"
105+
f" members: true\n"
106106
)
107107

108108
if md_prefix:
@@ -123,8 +123,7 @@ def create_entity_docs(
123123
f"# [{item_name}]"
124124
f"({index_link})\n\n"
125125
f"::: {zenml_import_path}.{item.stem}\n"
126-
f" handler: python\n"
127-
f" selection:\n"
126+
f" options:\n"
128127
f" members: false\n"
129128
)
130129
index_file_contents.append(index_entry)

0 commit comments

Comments
 (0)