From 2b2f215fbcecff4e70dd5ffac1240cb62491384c Mon Sep 17 00:00:00 2001 From: Harshal Pohekar Date: Wed, 11 Dec 2024 15:35:05 +0530 Subject: [PATCH] docs: Update API reference and cheat sheet --- doc/api_rstgen.py | 8 ++++---- doc/source/api/index.rst | 1 + 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/api_rstgen.py b/doc/api_rstgen.py index d65a1928910..daafaa8e178 100644 --- 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 index 335561e1781..e788635c47b 100644 --- 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