Skip to content

Commit

Permalink
build: Do not show type hint in the signature (#258)
Browse files Browse the repository at this point in the history
  • Loading branch information
tachikoma-li committed Feb 10, 2023
1 parent 0a3aa1a commit e09aa62
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,9 @@
# Option to automatically generate summaries.
autosummary_generate = True

# Hide type hints in signatures.
autodoc_typehints = "none"

public_apis = qctrlopencontrols.__all__

# the key of autosummary_context can be used
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ def new_cpmg_sequence(
References
----------
.. [#] `S. Meiboom and D. Gill, Review of Scientific Instruments 29:8, 688 (1958).
<https://link.aps.org/doi/10.1063/1.1716296>`_
<https://doi.org/10.1063/1.1716296>`_
"""

check_arguments(
Expand Down

0 comments on commit e09aa62

Please sign in to comment.