Skip to content
This repository has been archived by the owner on Aug 19, 2023. It is now read-only.

Remove dependency on sphinx-autodoc-typehints #1716

Merged
merged 1 commit into from
Apr 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx.ext.extlinks',
'sphinx_autodoc_typehints',
'jupyter_sphinx',
'nbsphinx',
'sphinx_design',
Expand Down Expand Up @@ -161,6 +160,13 @@
autosummary_generate_overwrite = False
autoclass_content = 'both'

# Move type hints from signatures to the parameter descriptions (except in overload cases, where
# that's not possible).
autodoc_typehints = "description"
# Only add type hints from signature to description body if the parameter has documentation. The
# return type is always added to the description (if in the signature).
autodoc_typehints_description_target = "documented_params"

# Plot directive configuration
# ----------------------------

Expand Down
3 changes: 1 addition & 2 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
qiskit-ibmq-provider[visualization]
numpy>=1.17
Sphinx~=4.0
Sphinx>=5.0
qiskit-sphinx-theme~=1.10.3
sphinx-autodoc-typehints>=1.8.0
pylatexenc>=1.4
sphinx-automodapi
jupyter
Expand Down