docs: Update API reference and cheat sheet (#3564)

* docs: Update API reference and cheat sheet * fix: tinytex issues * Use quarto * Use quarto 1 * Use quarto 2 * Use quarto 3 --------- Co-authored-by: Roberto Pastor Muela <[email protected]>
ansys · Dec 13, 2024 · 323931c · 323931c
1 parent 2e41f58
commit 323931c
Show file tree

Hide file tree

Showing 13 changed files with 174 additions and 224 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -115,6 +115,24 @@ jobs:
           restore-keys: |
             Python-${{ runner.os }}-${{ matrix.python-version }}
 
+      - name: Install Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+
+      - name: Check Quarto Version
+        shell: bash
+        run: |
+          quarto --version
+
+      - name: Verify tinytex is installed
+        run: |
+          quarto install tinytex --no-prompt --update-path
+
+      - name: "Install Poppler for PDF to PNG conversion"
+        shell: bash
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y poppler-utils
+
       - name: Install pyfluent
         run: make install
 

diff --git a/.github/workflows/doc-build-dev-nightly.yml b/.github/workflows/doc-build-dev-nightly.yml
@@ -34,22 +34,6 @@ jobs:
           sudo apt update
           sudo apt-get install pandoc libegl1 make xvfb libfontconfig1 libxrender1 libxkbcommon-x11-0 -y
 
-      - name: Install Quarto
-        uses: quarto-dev/quarto-actions/setup@v2
-        with:
-          tinytex: true
-
-      - name: Check Quarto Version
-        shell: bash
-        run: |
-          quarto --version
-
-      - name: "Install Poppler for PDF to PNG conversion"
-        shell: bash
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y poppler-utils
-
       - name: Install pyfluent
         run: make install
 

diff --git a/.github/workflows/doc-build-release.yml b/.github/workflows/doc-build-release.yml
@@ -36,22 +36,6 @@ jobs:
           sudo apt update
           sudo apt-get install pandoc libegl1 make xvfb libfontconfig1 libxrender1 libxkbcommon-x11-0 -y
 
-      - name: Install Quarto
-        uses: quarto-dev/quarto-actions/setup@v2
-        with:
-          tinytex: true
-
-      - name: Check Quarto Version
-        shell: bash
-        run: |
-          quarto --version
-
-      - name: "Install Poppler for PDF to PNG conversion"
-        shell: bash
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y poppler-utils
-
       - name: Install pyfluent
         run: make install
 

diff --git a/doc/api_rstgen.py b/doc/api_rstgen.py
@@ -173,8 +173,8 @@ def _generate_api_source_rst_files(folder: str, files: list):
                             f".. automodule:: ansys.fluent.core.{folder}.{file}\n"
                         )
                 else:
-                    rst.write(f"ansys.fluent.core.{file}\n")
-                    rst.write(f'{"="*(len(f"ansys.fluent.core.{file}"))}\n\n')
+                    rst.write(f"{file}\n")
+                    rst.write(f'{"="*(len(f"{file}"))}\n\n')
                     rst.write(f".. automodule:: ansys.fluent.core.{file}\n")
                 if "root" not in file:
                     _write_common_rst_members(rst_file=rst)
@@ -191,8 +191,8 @@ def _generate_api_index_rst_files():
             file = _get_file_path(folder, "index")
             with open(file, "w", encoding="utf8") as index:
                 index.write(f".. _ref_{folder}:\n\n")
-                index.write(f"ansys.fluent.core.{folder}\n")
-                index.write(f'{"="*(len(f"ansys.fluent.core.{folder}"))}\n\n')
+                index.write(f"{folder}\n")
+                index.write(f'{"="*(len(f"{folder}"))}\n\n')
                 index.write(f".. automodule:: ansys.fluent.core.{folder}\n")
                 _write_common_rst_members(rst_file=index)
                 index.write(".. toctree::\n")

diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst
@@ -10,6 +10,7 @@ full guidelines on their use.
 .. toctree::
     :maxdepth: 2
     :hidden:
+    :caption: ansys.fluent.core
 
     filereader/index
     launcher/index