Skip to content

Commit d403404

Browse files
Add QuaLiKiz-style API docs
1 parent 4894385 commit d403404

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

docs/source/api.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,18 @@
33
API reference
44
=============
55

6-
This page provides a summary of IMASPy's API. For more details
6+
This page provides an auto-generated summary of IMASPy's API. For more details
77
and examples, refer to the relevant chapters in the main part of the
88
documentation.
99

1010
IMASPy IDS manipulation
11-
------------------------
11+
-------------------------
1212

1313
.. autosummary::
1414
:toctree: generated/
15-
:template: custom-module-template.rst
1615
:recursive:
1716

18-
ids_classes.IDSPrimitive
17+
18+
ids_root.IDSRoot
19+
ids_toplevel.IDSToplevel
20+
ids_primitive.IDSPrimitive

docs/source/conf.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@
5555
iter_projects = "https://git.iter.org/projects/"
5656
imas_repos = urljoin(iter_projects, "IMAS/")
5757
imex_repos = urljoin(iter_projects, "IMEX/")
58+
dd_url = urljoin(imas_repos, "repos/data-dictionary/")
59+
al_url = urljoin(imas_repos, "repos/access-layer/")
5860
al_cython_url = urljoin(imas_repos, "repos/al-cython/")
5961
al_python_hli_url = urljoin(imas_repos, "repos/al-python/")
6062
al_python_lib_url = urljoin(imas_repos, "repos/al-python-lib/")
@@ -74,9 +76,11 @@
7476
"issue": (issue_url + "%s", "#"),
7577
"merge": (mr_url + "%s", "!"),
7678
"netcdf4": (netcdf4_docs + "%s", "netcdf4 "),
77-
"al_cython": (al_cython_url + "%s", "al_cython "),
78-
"al_hli": (al_python_hli_url + "%s", "al_hli"),
79-
"al_lib": (al_python_lib_url + "%s", "al_lib"),
79+
"dd": (dd_url, ""),
80+
"al": (al_url, ""),
81+
"al_cython": (al_cython_url + "%s", ""),
82+
"al_hli": (al_python_hli_url + "%s", ""),
83+
"al_lib": (al_python_lib_url + "%s", ""),
8084
"pypa": ("https://packaging.python.org/%s", None),
8185
}
8286

0 commit comments

Comments
 (0)