Attempt to fix sphinx generation

Signed-off-by: Will Killian <[email protected]>

docs/CMakeLists.txt

@@ -21,7 +21,7 @@ find_package(Sphinx REQUIRED)
 set(SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR}/source)
 set(SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}/html)
 set(SPHINX_LINKCHECK_OUT ${CMAKE_CURRENT_BINARY_DIR}/linkcheck)
-set(SPHINX_ARGS -j auto -T -W)
+set(SPHINX_ARGS -j auto -T)
 set(SPHINX_HTML_ARGS -b html ${SPHINX_ARGS})
 set(SPHINX_LINKCHECK_ARGS -b linkcheck ${SPHINX_ARGS})
 

docs/source/conf.py

@@ -56,7 +56,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'morpheus'
-copyright = '2024, NVIDIA'
+copyright = '2025, NVIDIA'
 author = 'NVIDIA'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -124,7 +124,7 @@
     "exhaleExecutesDoxygen":
         True,
     "exhaleDoxygenStdin":
-        textwrap.dedent('''
+        textwrap.dedent(r'''
         BRIEF_MEMBER_DESC = YES
         BUILTIN_STL_SUPPORT = YES
         DOT_IMAGE_FORMAT = svg
@@ -141,8 +141,7 @@
         ENABLE_PREPROCESSING = YES
         MACRO_EXPANSION = YES
         EXPAND_ONLY_PREDEF = NO
-        PREDEFINED = "MORPHEUS_EXPORT=" \
-                     "DOXYGEN_SHOULD_SKIP_THIS=1"
+        PREDEFINED += "MORPHEUS_EXPORT="
     ''')
 }
 

python/morpheus/morpheus/controllers/rss_controller.py

@@ -320,7 +320,7 @@ def parse_feeds(self):
         """
         Parse the RSS feed using the feedparser library.
 
-        Yeilds
+        Yields
         ------
         feedparser.FeedParserDict
             The parsed feed content.
@@ -350,7 +350,7 @@ def fetch_dataframes(self):
         """
         Fetch and process RSS feed entries.
 
-        Yeilds
+        Yields
         ------
         DataFrameType
             A DataFrame containing feed entry data.

python/morpheus/morpheus/utils/schema_transforms.py

@@ -67,8 +67,8 @@ def process_dataframe(
         The processed DataFrame. If 'df_in' was a pd.DataFrame, the return type is also pd.DataFrame,
         otherwise, it is cudf.DataFrame.
 
-    Note
-    ----
+    Notes
+    -----
     Any transformation that needs to be performed should be defined in 'input_schema'.
     If 'df_in' is a pandas DataFrame, it is temporarily converted into a cudf DataFrame for the transformation.
     """

python/morpheus_dfp/morpheus_dfp/modules/dfp_data_prep.py

@@ -40,7 +40,7 @@ def dfp_data_prep(builder: mrc.Builder):
         Pipeline builder instance.
 
     Notes
-    ----------
+    -----
         Configurable parameters:
             - schema: Schema of the data
             - timestamp_column_name: Name of the timestamp column

python/morpheus_dfp/morpheus_dfp/modules/dfp_inference.py

@@ -43,7 +43,7 @@ def dfp_inference(builder: mrc.Builder):
         Pipeline builder instance.
 
     Notes
-    ----------
+    -----
         Configurable parameters:
             - model_name_formatter (str): Formatter for model names; Example: "user_{username}_model";
               Default: `[Required]`

python/morpheus_dfp/morpheus_dfp/modules/dfp_inference_pipe.py

@@ -45,7 +45,7 @@ def dfp_inference_pipe(builder: mrc.Builder):
         Pipeline builder instance.
 
     Notes
-    ----------
+    -----
         Configurable parameters:
             - batching_options (dict): Options for batching the data; Example: See Below
             - cache_dir (str): Directory to cache the rolling window data; Example: "/path/to/cache/dir";

python/morpheus_dfp/morpheus_dfp/modules/dfp_postprocessing.py

@@ -38,7 +38,7 @@ def dfp_postprocessing(builder: mrc.Builder):
         Pipeline builder instance.
 
     Notes
-    ----------
+    -----
     Configurable parameters:
         - timestamp_column_name (str): Name of the timestamp column in the input data.
     """

python/morpheus_dfp/morpheus_dfp/modules/dfp_preproc.py

@@ -41,7 +41,7 @@ def dfp_preproc(builder: mrc.Builder):
         Pipeline builder instance.
 
     Notes
-    ----------
+    -----
         Configurable parameters:
             - cache_dir (str): Directory for caching intermediate results
             - timestamp_column_name (str): Name of the column containing timestamps

python/morpheus_llm/morpheus_llm/service/vdb/kinetica_vector_db_service.py

@@ -47,15 +47,15 @@ def is_collection_name_fully_qualified(name: str):
         return bool(re.fullmatch(r'[^.]+\.[^.]+', name))
 
 
-class DistanceStrategy(str, enum.Enum):
+class DistanceStrategy(enum.StrEnum):
     """Enumerator of the Distance strategies."""
 
     EUCLIDEAN = "l2"
     COSINE = "cosine"
     MAX_INNER_PRODUCT = "inner"
 
 
-class Dimension(int, enum.Enum):
+class Dimension(enum.IntEnum):
     """Some default dimensions for known embeddings."""
 
     OPENAI = 1536
@@ -973,10 +973,10 @@ def drop(self, name: str, **kwargs: dict[str, typing.Any]) -> None:
         **kwargs : dict
             Additional keyword arguments for specifying the type and partition name (if applicable).
 
-        Notes on Expected Keyword Arguments:
-        ------------------------------------
-        - 'schema' (str, optional):
-        Specifies the schema of the table to drop. Default 'ki_home'
+        Other Parameters
+        ----------------
+        schema : str
+            Specifies the schema of the table to drop. Default 'ki_home'
 
         Raises
         ------
@@ -987,7 +987,6 @@ def drop(self, name: str, **kwargs: dict[str, typing.Any]) -> None:
         logger.debug("Dropping Kinetica table: %s, kwargs=%s", name, kwargs)
 
         if self.has_store_object(name):
-            # schema = kwargs.get("schema", "ki_home")
             try:
                 self._client.clear_table(name)
             except GPUdbException as e:

python/morpheus_llm/morpheus_llm/service/vdb/milvus_vector_db_service.py

@@ -1041,19 +1041,19 @@ def drop(self, name: str, **kwargs: dict[str, typing.Any]) -> None:
         **kwargs : dict
             Additional keyword arguments for specifying the type and partition name (if applicable).
 
-        Notes on Expected Keyword Arguments:
-        ------------------------------------
-        - 'collection' (str, optional):
-        Specifies the type of collection to drop. Possible values: 'collection' (default), 'index', 'partition'.
+        Other Parameters
+        ----------------
+        collection: str
+            Type of collection to drop. Possible values: 'collection' (default), 'index', 'partition'.
 
-        - 'partition_name' (str, optional):
-        Required when dropping a specific partition within a collection. Specifies the partition name to be dropped.
+        partition_name: str
+            The partition name to be dropped. Required when dropping a specific partition within a collection.
 
-        - 'field_name' (str, optional):
-        Required when dropping an index within a collection. Specifies the field name for which the index is created.
+        field_name: str
+            The field name for which the index is created. Required when dropping an index within a collection.
 
-        - 'index_name' (str, optional):
-        Required when dropping an index within a collection. Specifies the name of the index to be dropped.
+        index_name: str
+            The name of the index to be dropped. Required when dropping an index within a collection.
 
         Raises
         ------