Skip to content

Commit c949e73

Browse files
committed
docs: Use custom template for api reference landing page
1 parent 2e458a9 commit c949e73

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

doc/source/_templates/index.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
API Reference
2+
=============
3+
4+
This section contains PyRocky API endpoints, their capabilities, and how to interact with them
5+
programmatically [#f1]_.
6+
7+
.. toctree::
8+
:titlesonly:
9+
10+
/api/ansys/rocky/core/index
11+
12+
.. [#f1] Created with `sphinx-autoapi <https://github.com/readthedocs/sphinx-autoapi>`_

doc/source/conf.py

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22

33
from datetime import datetime
44
import os
5-
from pathlib import Path
65

76
from ansys_sphinx_theme import (
87
ansys_favicon,
9-
get_autoapi_templates_dir_relative_path,
108
get_version_match,
119
)
1210
from ansys_sphinx_theme import pyansys_logo_black as logo
@@ -126,15 +124,13 @@
126124
"undoc-members",
127125
"show-inheritance",
128126
"show-module-summary",
129-
"special-members",
127+
# "special-members", # exclude dunder methods
130128
]
131-
autoapi_template_dir = get_autoapi_templates_dir_relative_path(Path(__file__))
129+
autoapi_template_dir = "_templates"
132130
suppress_warnings = ["autoapi.python_import_resolution"]
133131
autoapi_python_use_implicit_namespaces = True
134132
autoapi_keep_files = True
135133
autoapi_render_in_single_page = ["class", "enum", "exception"]
136134

137135
# PyAnsys tags configuration
138-
html_context = {
139-
"pyansys_tags": ['Fluids']
140-
}
136+
html_context = {"pyansys_tags": ["Fluids"]}

0 commit comments

Comments
 (0)