Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update API reference and cheat sheet #3564

Merged
merged 7 commits into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
16 changes: 0 additions & 16 deletions .github/workflows/doc-build-dev-nightly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
16 changes: 0 additions & 16 deletions .github/workflows/doc-build-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions doc/api_rstgen.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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")
Expand Down
1 change: 1 addition & 0 deletions doc/source/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ full guidelines on their use.
.. toctree::
:maxdepth: 2
:hidden:
:caption: ansys.fluent.core

filereader/index
launcher/index
Expand Down
Loading
Loading