Skip to content

Commit

Permalink
Fixing docs size (#2395)
Browse files Browse the repository at this point in the history
  • Loading branch information
ItayGabbay committed Mar 13, 2023
1 parent 30cb5d1 commit bbcc98f
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/source/api/index.rst
Expand Up @@ -5,6 +5,7 @@ Here you can see the api reference.

.. toctree::
:caption: API Reference
:maxdepth: 2
:hidden:

deepchecks.core
Expand Down
13 changes: 11 additions & 2 deletions docs/source/conf.py
Expand Up @@ -229,6 +229,8 @@
#
autosummary_ignore_module_all = False

autodoc_typehints = "none"

# A dictionary of values to pass into the template engine’s context
# for autosummary stubs files.

Expand All @@ -253,6 +255,8 @@ def getswd(pth: str):
"deepchecks.vision.checks": "../deepchecks.vision.checks",
"deepchecks.tabular.suites": "../deepchecks.tabular.suites",
"deepchecks.vision.suites": "../deepchecks.vision.suites",
"deepchecks.nlp.checks": "../deepchecks.nlp.checks",
"deepchecks.nlp.suites": "../deepchecks.nlp.suites"
}

# -- autodoc settings --------------------------------------------------
Expand Down Expand Up @@ -418,7 +422,8 @@ def linkcode_resolve(domain, info):
#
html_theme_options = {
"collapse_navigation": False,
"navigation_depth": 6,
"navigation_depth": 3,
"show_nav_level": 3,
"navbar_end": ["version-switcher", "navbar-icon-links", "menu-dropdown", ],
# "page_sidebar_items": ["page-toc", "create-issue", "show-page-source"],
"page_sidebar_items": ["page-toc", ],
Expand Down Expand Up @@ -470,6 +475,7 @@ def get_check_example_api_reference(filepath: str) -> t.Optional[str]:
if not (
filepath.startswith("checks_gallery/tabular/")
or filepath.startswith("checks_gallery/vision/")
or filepath.startswith("checks_gallery/nlp/")
):
return ''

Expand All @@ -483,9 +489,12 @@ def get_check_example_api_reference(filepath: str) -> t.Optional[str]:
if filepath.startswith("checks_gallery/tabular/"):
import deepchecks.tabular.checks
check_clazz = getattr(deepchecks.tabular.checks, notebook_name, None)
else:
elif filepath.startswith("checks_gallery/vision/"):
import deepchecks.vision.checks
check_clazz = getattr(deepchecks.vision.checks, notebook_name, None)
else:
import deepchecks.nlp.checks
check_clazz = getattr(deepchecks.nlp.checks, notebook_name, None)

if check_clazz is None or not hasattr(check_clazz, "__module__"):
return
Expand Down

0 comments on commit bbcc98f

Please sign in to comment.