fix: Comments

Author: AlejandroFernandezLuces

.github/workflows/ci_cd.yml

@@ -121,7 +121,7 @@ jobs:
   release:
     name: "Release project"
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
-    needs: [code-style]
+    needs: [docs-build, tests]
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code

.pre-commit-config.yaml

@@ -6,27 +6,28 @@ repos:
     additional_dependencies: [black==23.12.1]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.5.0
+  rev: v4.6.0
   hooks:
   - id: check-merge-conflict
   - id: debug-statements
   - id: check-yaml
   - id: trailing-whitespace
 
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.27.3
+  rev: 0.29.1
   hooks:
     - id: check-github-workflows
 
 
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.5.5
+  rev: v0.5.7
   hooks:
     - id: ruff
       args: [--fix]
+    - id: ruff-format
 
 - repo: https://github.com/ansys/pre-commit-hooks
-  rev: v0.3.1
+  rev: v0.4.3
   hooks:
     - id: add-license-headers
       files: '(src|examples|tests|docker)/.*\.(py)|\.(proto)'

doc/Makefile

@@ -33,6 +33,4 @@ pdf:
 
 # Build HTML files and generate examples as .py files
 html:
-	pip uninstall vtk -y
-	pip install --extra-index-url https://wheels.vtk.org vtk-osmesa
 	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/source/conf.py

@@ -2,17 +2,14 @@
 
 from datetime import datetime
 import os
-from pathlib import Path
 
 from allie.flowkit import __version__
 from ansys_sphinx_theme import (
     ansys_favicon,
     ansys_logo_white,
     ansys_logo_white_cropped,
-    get_autoapi_templates_dir_relative_path,
     get_version_match,
     latex,
-    pyansys_logo_black,
     watermark,
 )
 from sphinx.builders.latex import LaTeXBuilder
@@ -28,7 +25,6 @@
 switcher_version = get_version_match(__version__)
 
 # Select desired logo, theme, and declare the html title
-html_logo = pyansys_logo_black
 html_theme = "ansys_sphinx_theme"
 html_short_title = html_title = "Allie Flowkit Python"
 html_baseurl = f"https://{cname}/version/stable"
@@ -41,6 +37,7 @@
     "doc_path": "doc/source",
 }
 html_theme_options = {
+    "logo": "pyansys",
     "switcher": {
         "json_url": f"https://{cname}/versions.json",
         "version_match": switcher_version,
@@ -65,9 +62,29 @@
             "url": f"https://{cname}/version/{switcher_version}/_static/assets/download/allie-flowkit-python.pdf",  # noqa: E501
             "icon": "fa fa-file-pdf fa-fw",
         },
-    ]
+    ],
+    "ansys_sphinx_theme_autoapi": {
+        "project": "Allie Flowkit Python",
+        "output": "api",
+        "use_implicit_namespaces": True,
+        "directory": "src",
+        "keep_files": True,
+        "own_page_level": "class",
+        "type": "python",
+        "options": [
+            "members",
+            "undoc-members",
+            "show-inheritance",
+            "show-module-summary",
+            "special-members",
+        ],
+        "class_content": "class",
+    },
 }
 
+suppress_warnings = ["autoapi.python_import_resolution", "design.grid", "config.cache", "autoapi.not_readable"]
+
+
 # Sphinx extensions
 extensions = [
     "sphinx.ext.intersphinx",
@@ -76,6 +93,7 @@
     "sphinx_jinja",
     "autoapi.extension",
     "numpydoc",
+    "ansys_sphinx_theme.extension.autoapi",
 ]
 
 nbsphinx_execute = "always"
@@ -148,46 +166,6 @@
 # The master toctree document.
 master_doc = "index"
 
-# Configuration for Sphinx autoapi
-autoapi_type = "python"
-autoapi_dirs = ["../../src"]
-autoapi_root = "api"
-autoapi_template_dir = get_autoapi_templates_dir_relative_path(Path(__file__))
-suppress_warnings = ["autoapi.python_import_resolution", "design.grid", "config.cache",  "autoapi.not_readable"]
-autoapi_python_use_implicit_namespaces = True
-autoapi_keep_files = True
-autoapi_own_page_level = "class"
-autoapi_add_toctree_entry = False
-# Examples gallery customization
-nbsphinx_execute = "always"
-
-nbsphinx_epilog = """
-----
-
-.. admonition:: Download this example
-
-    Download this example as a `Jupyter Notebook <{cname_pref}/{ipynb_file_loc}>`_
-    or as a `Python script <{cname_pref}/{py_file_loc}>`_.
-
-""".format(
-    cname_pref=f"https://{cname}/version/{switcher_version}",
-    ipynb_file_loc="{{ env.docname }}.ipynb",
-    py_file_loc="{{ env.docname }}.py",
-)
-
-nbsphinx_prolog = """
-
-.. admonition:: Download this example
-
-    Download this example as a `Jupyter Notebook <{cname_pref}/{ipynb_file_loc}>`_
-    or as a `Python script <{cname_pref}/{py_file_loc}>`_.
-
-----
-""".format(
-    cname_pref=f"https://{cname}/version/{switcher_version}",
-    ipynb_file_loc="{{ env.docname }}.ipynb",
-    py_file_loc="{{ env.docname }}.py",
-)
 
 typehints_defaults = "comma"
 simplify_optional_unions = False
@@ -200,9 +178,7 @@
 latex_elements = {"preamble": latex.generate_preamble(html_title)}
 
 linkcheck_exclude_documents = ["index", "getting_started/local/index", "assets"]
-linkcheck_ignore = [
-    "https://github.com/ansys/allie-flowkit-python/"
-]
+linkcheck_ignore = ["https://github.com/ansys/allie-flowkit-python/"]
 # -- Declare the Jinja context -----------------------------------------------
 exclude_patterns = [
     "examples/**/*.ipynb",

doc/source/index.rst

@@ -65,7 +65,7 @@ The Allie Flowkit Python offers these main features:
        getting_started/index
        user_guide/index
        {% if build_api %}
-       api/src/allie/flowkit/index
+       api/index
        {% endif %}
        {% if build_examples %}
        examples/index

docker/Dockerfile

@@ -7,7 +7,7 @@ COPY app/ ./src/allie/flowkit/
 COPY configs/config.yaml .
 
 # Install dependencies
-RUN pip install --no-cache-dir .
+RUN pip install --no-cache-dir .[all]
 
 EXPOSE 8000
 

pyproject.toml

@@ -43,10 +43,7 @@ tests = [
     "pytest-asyncio >= 0.23.8,<1",
 ]
 doc = [
-    "ansys-sphinx-theme==0.16.6",
-    "jupyter_sphinx==0.5.3",
-    "jupytext==1.16.4",
-    "nbsphinx==0.9.4",
+    "ansys-sphinx-theme==1.0.3",
     "numpydoc==1.7.0",
     "sphinx==8.0.2",
     "sphinx-autoapi==3.2.1",
@@ -108,7 +105,6 @@ ignore = ["D416"]
 
 [tool.ruff.format]
 quote-style = "double"
-indent-style = "tab"
 line-ending = "auto"
 
 [tool.ruff.lint.isort]

src/allie/flowkit/__init__.py

@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 """App package responsible for creating the FastAPI app."""
+
 import importlib.metadata as importlib_metadata
 
 __version__ = importlib_metadata.version(__name__.replace(".", "-") + "-python")

src/allie/flowkit/__main__.py

@@ -21,23 +21,23 @@
 # SOFTWARE.
 
 """Main module for the FlowKit service."""
+
 try:
     import uvicorn
 except ImportError:
-    raise ImportError(
-        "Please install uvicorn to run the service: pip install allie-flowkit-python[all]"
-    )
+    raise ImportError("Please install uvicorn to run the service: pip install allie-flowkit-python[all]")
 import argparse
 
 
 def main():
     """Run entrypoint for the FlowKit service."""
-    parse  = argparse.ArgumentParser()
+    parse = argparse.ArgumentParser()
     parse.add_argument("--host", type=str, default="0.0.0.0", help="The host to run the service on. By default 0.0.0.0")
     parse.add_argument("--port", type=int, default=8000, help="The port to run the service on. By default 8000")
     parse.add_argument("--workers", type=int, default=4, help="The number of workers to use. By default 4")
     args = parse.parse_args()
     uvicorn.run("allie.flowkit:flowkit_service", host=args.host, port=args.port, workers=args.workers)
 
+
 if __name__ == "__main__":
     main()

src/allie/flowkit/config/__init__.py

@@ -22,4 +22,4 @@
 
 """Configuration package for the application."""
 
-from allie.flowkit.config._config import CONFIG # noqa F401
+from allie.flowkit.config._config import CONFIG  # noqa F401