📚 Update Documentation and Docstrings

docs/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?=
+SPHINXOPTS    = -j auto
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = build

docs/source/conf.py

@@ -10,26 +10,25 @@
 # Copyright (C) 2022-2024 Intel Corporation
 # SPDX-License-Identifier: Apache-2.0
 
-from __future__ import annotations
-
 import sys
 from pathlib import Path
 
-# Define the path to your module using Path
-module_path = Path(__file__).parent.parent / "src"
+# Define paths
+project_root = Path(__file__).parent.parent.parent
+module_path = project_root / "src"
+examples_path = project_root / "examples"
 
-# Insert the path to sys.path
+# Insert paths to sys.path
 sys.path.insert(0, str(module_path.resolve()))
+sys.path.insert(0, str(project_root.resolve()))
 
 project = "Anomalib"
-copyright = "2023, Intel OpenVINO"  # noqa: A001
-author = "Intel OpenVINO"
-release = "2022"
+copyright = "Intel Corporation"  # noqa: A001
+author = "Intel Corporation"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.mathjax",
@@ -39,20 +38,49 @@
     "sphinx.ext.napoleon",
     "sphinx_autodoc_typehints",
     "sphinx_copybutton",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.autosectionlabel",
 ]
 
+# MyST configuration
 myst_enable_extensions = [
     "colon_fence",
-    # other MyST extensions...
+    "linkify",
+    "substitution",
+    "tasklist",
+    "deflist",
+    "fieldlist",
 ]
+
+# Add separate setting for eval-rst
+myst_enable_eval_rst = True
+
+# Notebook handling
 nbsphinx_allow_errors = True
+nbsphinx_execute = "auto"  # Execute notebooks during build
+nbsphinx_timeout = 300  # Timeout in seconds
+
+# Templates and patterns
 templates_path = ["_templates"]
-exclude_patterns: list[str] = []
+exclude_patterns: list[str] = [
+    "_build",
+    "**.ipynb_checkpoints",
+    "**/.pytest_cache",
+    "**/.git",
+    "**/.github",
+    "**/.venv",
+    "**/*.egg-info",
+    "**/build",
+    "**/dist",
+]
 
 # Automatic exclusion of prompts from the copies
 # https://sphinx-copybutton.readthedocs.io/en/latest/use.html#automatic-exclusion-of-prompts-from-the-copies
 copybutton_exclude = ".linenos, .gp, .go"
 
+# Enable section anchors for cross-referencing
+autosectionlabel_prefix_document = True
+
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
@@ -65,3 +93,13 @@
         "text": "Anomalib",
     },
 }
+
+# Add references to example files
+html_context = {"examples_path": str(examples_path)}
+
+# External documentation references
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "torch": ("https://pytorch.org/docs/stable", None),
+    "lightning": ("https://lightning.ai/docs/pytorch/stable/", None),
+}

docs/source/index.md

@@ -68,19 +68,11 @@ Learn more about anomalib API and CLI.
 Learn how to use anomalib for your anomaly detection tasks.
 :::
 
-:::{grid-item-card} {octicon}`telescope` Topic Guide
-:link: markdown/guides/topic/index
-:link-type: doc
-
-Learn more about the internals of anomalib.
-:::
-
 :::{grid-item-card} {octicon}`code` Developer Guide
 :link: markdown/guides/developer/index
 :link-type: doc
 
 Learn how to develop and contribute to anomalib.
-:::
 
 ::::
 
@@ -98,7 +90,6 @@ markdown/get_started/migration
 
 markdown/guides/reference/index
 markdown/guides/how_to/index
-markdown/guides/topic/index
 markdown/guides/developer/index
 ```
 

docs/source/markdown/guides/reference/callbacks/index.md

@@ -1,8 +1,90 @@
 # Callbacks
 
+```{grid} 2
+:gutter: 2
+
+:::{card} {octicon}`download` Model Checkpoint
+:link: checkpoint
+:link-type: ref
+
+Save and manage model checkpoints during training.
+:::
+
+:::{card} {octicon}`graph` Graph Logger
+:link: graph-logger
+:link-type: ref
+
+Log model computation graphs for visualization.
+:::
+
+:::{card} {octicon}`package` Load Model
+:link: load-model
+:link-type: ref
+
+Load pre-trained models and weights.
+:::
+
+:::{card} {octicon}`table` Tile Configuration
+:link: tile-configuration
+:link-type: ref
+
+Configure and manage image tiling settings.
+:::
+
+:::{card} {octicon}`clock` Timer
+:link: timer
+:link-type: ref
+
+Track and measure execution times during training.
+:::
+```
+
+(checkpoint)=
+
+## {octicon}`download` Model Checkpoint
+
+```{eval-rst}
+.. automodule:: anomalib.callbacks.checkpoint
+   :members:
+   :show-inheritance:
+```
+
+(graph-logger)=
+
+## {octicon}`graph` Graph Logger
+
+```{eval-rst}
+.. automodule:: anomalib.callbacks.graph
+   :members:
+   :show-inheritance:
+```
+
+(load-model)=
+
+## {octicon}`package` Load Model
+
+```{eval-rst}
+.. automodule:: anomalib.callbacks.model_loader
+   :members:
+   :show-inheritance:
+```
+
+(tile-configuration)=
+
+## {octicon}`table` Tile Configuration
+
+```{eval-rst}
+.. automodule:: anomalib.callbacks.tile_configuration
+   :members:
+   :show-inheritance:
+```
+
+(timer)=
+
+## {octicon}`clock` Timer
+
 ```{eval-rst}
-.. automodule:: anomalib.callbacks
+.. automodule:: anomalib.callbacks.timer
    :members:
-   :exclude-members: get_visualization_callbacks
    :show-inheritance:
 ```

docs/source/markdown/guides/reference/cli/index.md

@@ -1,7 +1,7 @@
 # CLI
 
 ```{eval-rst}
-.. automodule:: anomalib.cli
+.. automodule:: anomalib.cli.cli
    :members:
    :show-inheritance:
 ```