Skip to content

Doc: add link to the Ansys Help Composites page #708

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 27, 2024
Merged

Doc: add link to the Ansys Help Composites page #708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 10 additions & 6 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,15 +111,19 @@ def _signature(

SKIP_GALLERY = os.environ.get("PYACP_DOC_SKIP_GALLERY", "0").lower() in ("1", "true")
SKIP_API = os.environ.get("PYACP_DOC_SKIP_API", "0").lower() in ("1", "true")
SOURCE_DIR = pathlib.Path(__file__).parent

# nested example index files are directly included in the parent index file
exclude_patterns = ["examples/*/index.rst"]
if SKIP_API:
# Exclude all API documentation except the index
# The 'api/!(index).rst' syntax does not appear to be supported by Sphinx
for file_path in pathlib.Path("api").glob("**/*.rst"):
if str(file_path) != "api/index.rst":
exclude_patterns.append(str(file_path))
# Exclude all API documentation except the top-level index file:
# Exclude files on the top level explicitly, except 'index.rst'
for file_path in (SOURCE_DIR / "api").iterdir():
if not file_path.name == "index.rst":
pattern = str(file_path.relative_to(SOURCE_DIR).as_posix())
exclude_patterns.append(pattern)
# Exclude all files in nested directories
exclude_patterns.append("api/**/*.rst")


jinja_contexts = {
Expand Down Expand Up @@ -201,7 +205,7 @@ def _signature(
# "pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
"grpc": ("https://grpc.github.io/grpc/python/", None),
"protobuf": ("https://googleapis.dev/python/protobuf/latest/", None),
"pyvista": ("https://docs.pyvista.org/version/stable", None),
"pyvista": ("https://docs.pyvista.org/", None),
"ansys-dpf-core": ("https://dpf.docs.pyansys.com/version/stable/", None),
"ansys-dpf-composites": ("https://composites.dpf.docs.pyansys.com/version/stable/", None),
"ansys-mechanical-core": ("https://mechanical.docs.pyansys.com/version/stable/", None),
Expand Down
6 changes: 6 additions & 0 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ optimization of composite structures.

Information on how to contribute to PyACP.

.. grid-item-card:: :octicon:`mortar-board` ACP documentation
:link: https://ansyshelp.ansys.com/public/?returnurl=/Views/Secured/prod_page.html?pn=Composites&pid=CompositePrepPost
:columns: 12

Describes the modeling features and techniques of Ansys Composite PrepPost.


.. _limitations:

Expand Down
Loading