Skip to content

Commit c6009f2

Browse files
Jammy2211Jammy2211
authored andcommitted
update pyproject for docs
1 parent 44e64f3 commit c6009f2

3 files changed

Lines changed: 15 additions & 6 deletions

File tree

docs/api/data.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ applied to datasets to apply over sampling to their fit.
6767
:template: custom-class-template.rst
6868
:recursive:
6969

70-
OverSampling
70+
OverSampler
7171

7272

7373
1D Data Structures

docs/api/modeling.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,5 @@ Adapt
6565
.. autosummary::
6666
:toctree: generated/
6767

68-
SetupAdapt
68+
AdaptImages
69+
AdaptImageMaker

docs/conf.py

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@
4343
"sphinx.ext.intersphinx",
4444
"sphinx.ext.mathjax",
4545
"sphinx.ext.todo",
46-
"sphinx.ext.napoleon",
4746
"sphinx.ext.viewcode",
48-
"sphinx_autodoc_typehints", # Automatically document param types (less noise in class signature)
47+
"sphinx.ext.napoleon",
4948
"numpydoc",
50-
# External stuff
49+
"sphinx_autodoc_typehints",
50+
# external
5151
"myst_parser",
5252
"sphinx_copybutton",
5353
"sphinx_design",
@@ -82,7 +82,11 @@
8282
autosummary_generate = True
8383
autosummary_imported_members = True
8484
autodoc_member_order = "bysource"
85-
autodoc_default_flags = ["members"]
85+
autodoc_default_options = {
86+
"members": True,
87+
"undoc-members": True,
88+
"show-inheritance": True,
89+
}
8690
autodoc_class_signature = "separated"
8791
autoclass_content = "init"
8892

@@ -133,3 +137,7 @@
133137
from sphinx.builders.html import StandaloneHTMLBuilder
134138

135139
StandaloneHTMLBuilder.supported_image_types = ["image/gif", "image/png", "image/jpeg"]
140+
141+
typehints_fully_qualified = False
142+
always_document_param_types = False
143+
typehints_document_rtype = False

0 commit comments

Comments
 (0)