-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[doc][api][info] Provide machine-independant docstrings.
- Loading branch information
1 parent
ff7b16b
commit 3f0e8f6
Showing
2 changed files
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,52 @@ | ||
pyxu.info.ptype | ||
=============== | ||
|
||
.. [Sepand, 2023.09.15] | ||
.. `pyxu.info.ptype` contains alias types for Python type checkers. When auto-documented via Sphinx, alias types | ||
.. contain "alias of ..." as part of their docstring, which depends on the machine config. (Was unable to remove them | ||
.. via Sphinx's `autodoc-process-docstring` event.) To avoid machine-dependant outputs in HTML docs, we provide custom | ||
.. machine-agnostic documentation for some aliases as required. Provided descriptions match those given as comments in | ||
.. `pyxu.info.ptype`. | ||
.. automodule:: pyxu.info.ptype | ||
:exclude-members: NDArray, ArrayModule, SparseArray, SparseModule, OpT, Property, SolverT, SolverM, Real, DType | ||
|
||
.. class:: NDArray | ||
|
||
Supported dense array types. | ||
|
||
.. class:: ArrayModule | ||
|
||
Supported dense array modules. | ||
|
||
.. class:: SparseArray | ||
|
||
Supported sparse array types. | ||
|
||
.. class:: SparseModule | ||
|
||
Supported sparse array modules. | ||
|
||
.. class:: OpT | ||
|
||
Top-level abstract :py:class:`~pyxu.abc.Operator` interface exposed to users. | ||
|
||
.. autodata:: Property | ||
:no-value: | ||
|
||
.. class:: SolverT | ||
|
||
Top-level abstract :py:class:`~pyxu.abc.Solver` interface exposed to users. | ||
|
||
.. class:: SolverM | ||
|
||
Solver run-mode(s). | ||
|
||
.. class:: Real | ||
|
||
Alias of :py:class:`numbers.Real`. | ||
|
||
.. data:: DType | ||
|
||
:py:attr:`~pyxu.info.ptype.NDArray` dtype specifier. |