build: Bump version to v0.19.2

Author: prmukherj

Makefile

@@ -22,6 +22,7 @@ unittest:
 build-doc:
 	@sudo rm -rf /home/ansys/.local/share/ansys_fluent_core/examples/*
 	@pip install -r requirements/requirements_doc.txt
+	@python doc/api_rstgen.py
 	@xvfb-run make -C doc html
 	@touch doc/_build/html/.nojekyll
 	@echo "$(DOCS_CNAME)" >> doc/_build/html/CNAME

doc/Makefile

@@ -16,6 +16,7 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
+	python api_rstgen.py;
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	@cp -f "$(SOURCEDIR)/_static/sphx_glr_post_processing_exhaust_manifold_011.png" "$(BUILDDIR)/html/_images/"
 	@cp -f "$(SOURCEDIR)/_static/sphx_glr_post_processing_exhaust_manifold_012.png" "$(BUILDDIR)/html/_images/"

doc/api_rstgen.py

@@ -0,0 +1,96 @@
+"""Provides a module for generating PyFluent API RST files."""
+
+from pathlib import Path
+
+
+def _get_folder_path(folder_name: str):
+    """Get folder path.
+
+    Parameters
+    ----------
+    folder_name: str
+        Name of the folder.
+
+    Returns
+    -------
+        Path of the folder.
+    """
+    return (Path(__file__) / ".." / "source" / folder_name).resolve()
+
+
+def _get_file_path(folder_name: str, file_name: str):
+    """Get file path.
+
+    Parameters
+    ----------
+    folder_name: str
+        Name of the folder.
+
+    file_name: str
+        Name of the file.
+
+    Returns
+    -------
+        Path of the file.
+    """
+    return (
+        Path(__file__) / ".." / "source" / folder_name / f"{file_name}.rst"
+    ).resolve()
+
+
+hierarchy = {
+    "visualization": [
+        "Mesh",
+        "Surface",
+        "Contour",
+        "Vector",
+        "Pathline",
+        "XYPlot",
+        "Monitor",
+        "GraphicsWindow",
+    ]
+}
+
+
+def _write_common_rst_members(rst_file):
+    rst_file.write("    :members:\n")
+    rst_file.write("    :show-inheritance:\n")
+    rst_file.write("    :undoc-members:\n")
+    rst_file.write("    :exclude-members: __weakref__, __dict__\n")
+    rst_file.write("    :special-members: __init__\n")
+    # rst_file.write("    :autosummary:\n")
+
+
+def _generate_api_source_rst_files(folder: str, files: list):
+    for file in files:
+        if not file.endswith("_contents"):
+            rst_file = _get_file_path(folder, file)
+            with open(rst_file, "w", encoding="utf8") as rst:
+                rst.write(f".. _ref_{file}:\n\n")
+                rst.write(f"{file}\n")
+                rst.write(f'{"="*(len(f"{file}"))}\n\n')
+                rst.write(f".. autoclass:: ansys.fluent.visualization.{file}\n")
+                _write_common_rst_members(rst_file=rst)
+
+
+def _generate_api_index_rst_files():
+    for folder, files in hierarchy.items():
+        Path(_get_folder_path(folder)).mkdir(parents=True, exist_ok=True)
+        _generate_api_source_rst_files(folder, files)
+        folder_index = _get_file_path(folder, f"{folder}_contents")
+        with open(folder_index, "w", encoding="utf8") as index:
+            index.write(f".. _ref_{folder}:\n\n")
+            index.write(f"{folder}\n")
+            index.write(f'{"=" * (len(f"{folder}"))}\n\n')
+            index.write(f".. automodule:: ansys.fluent.{folder}\n")
+            _write_common_rst_members(rst_file=index)
+            index.write(".. toctree::\n")
+            index.write("    :maxdepth: 2\n")
+            index.write("    :hidden:\n\n")
+            for file in files:
+                index.write(f"    {file}\n")
+            index.write("\n")
+
+
+if __name__ == "__main__":
+    _generate_api_index_rst_files()

doc/make.bat

@@ -16,6 +16,8 @@ set SPHINXOPTS=-j auto -W --keep-going -w build_errors.txt -N -q
 if "%1" == "" goto help
 if "%1" == "clean" goto clean
 
+python api_rstgen.py
+
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
 	echo.