Skip to content

Commit ae23192

Browse files
committed
fix: Advanced autodoc config for decorated methods (inherit_docstrings)
1 parent 163957f commit ae23192

File tree

1 file changed

+30
-9
lines changed

1 file changed

+30
-9
lines changed

docs/conf.py

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,38 @@
1717
'sphinx_rtd_theme'
1818
]
1919

20-
# Configuración de napoleon
21-
napoleon_google_docstring = True
22-
napoleon_numpy_docstring = False
23-
napoleon_include_init_with_doc = True
24-
25-
# Configuración de autodoc
20+
# Configuración CRÍTICA para métodos decorados
2621
autodoc_default_options = {
2722
'members': True,
2823
'undoc-members': True,
29-
'member-order': 'bysource'
24+
'member-order': 'bysource',
25+
'special-members': '__init__',
26+
'private-members': False,
27+
'show-inheritance': True,
28+
'inherited-members': False,
3029
}
3130

32-
# Para métodos decorados
31+
# IMPORTANTE para preservar docstrings con decoradores
3332
autodoc_inherit_docstrings = True
33+
autodoc_preserve_defaults = True # Preserva valores por defecto
34+
autodoc_typehints = 'signature' # Muestra type hints
35+
autodoc_typehints_format = 'short'
36+
autodoc_class_signature = 'separated'
37+
38+
# Configuración de napoleon para docstrings estilo Google
39+
napoleon_google_docstring = True
40+
napoleon_numpy_docstring = False
41+
napoleon_include_init_with_doc = True
42+
napoleon_include_private_with_doc = False
43+
napoleon_include_special_with_doc = True
44+
napoleon_use_admonition_for_examples = True
45+
napoleon_use_admonition_for_notes = True
46+
napoleon_use_admonition_for_references = True
47+
napoleon_use_ivar = True
48+
napoleon_use_param = True
49+
napoleon_use_rtype = True
50+
napoleon_use_keyword = True
51+
napoleon_preprocess_types = True
3452

3553
# Mockear importaciones problemáticas
3654
autodoc_mock_imports = [
@@ -42,7 +60,10 @@
4260
'six',
4361
'python-dotenv',
4462
'pyyaml',
45-
'ad_api', # Mockear el paquete principal
63+
# Mockear módulos específicos de ad_api si es necesario
64+
'ad_api.base',
65+
'ad_api.api',
66+
'ad_api.api.sp',
4667
]
4768

4869
# Templates

0 commit comments

Comments
 (0)