DOC: Hyperlinks to QuTiP functions and classes
See original GitHub issueIt would be nice if the docstrings in QuTiP were well formatted, such that, when Sphinx builds the API and guidelines documentation, there are working link to QuTiP functions and classes. An example of working link is qutip.steadystate.steadystate
in
http://qutip.org/docs/latest/guide/guide-steady.html#steady-state-solvers-in-qutip
An example of working link in the API doc is options: qutip.solver.Options
in the attributes of the HEOMSolver
class
http://qutip.org/docs/latest/apidoc/classes.html#non-markovian-solvers
A way to proceed would be to:
-
reformat all instances in the docstrings of qutip/qutip such that they are in the form of :py:meth:
mymodule.MyClass.mymethod
, see https://stackoverflow.com/questions/22700606/how-would-i-cross-reference-a-function-generated-by-autodoc-in-sphinx -
Build the documentation with Sphinx to check that the change works and generates an active hyperlink in the relative html page of the documentation.
-
Iterate 1) and 2) for instances in which Qobj or other QuTiP functions or classes are found.
Issue Analytics
- State:
- Created 4 years ago
- Comments:8 (8 by maintainers)
Top GitHub Comments
I just registered for the unitaryhack and saw this issue. I could have a look at it.
An example is in the
Dicke
class of PIQS, the permutational invariant solver. The docstring saysIdeally, the hamiltonian specification as
:class: qutip.Qobj
should be a hyperlink. Formatting it correctly with :: and the correct spaces should make it work.Another example is in the docstring of the
basis()
, andbell_state()
functiona, which returns astate:qobj
. This could point to the Qobj class.