Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove dependency on sphinx-autodoc-typehints #9705

Merged
merged 3 commits into from
Mar 24, 2023
Merged

Remove dependency on sphinx-autodoc-typehints #9705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6301056
Remove dependency on sphinx-autodoc-typehints
jakelishman Mar 1, 2023
9a92f3a
Maintain previous type-hint behaviour
jakelishman Mar 2, 2023
2007191
Merge remote-tracking branch 'ibm/main' into remove-sphinx-autodoc-ty…
jakelishman Mar 2, 2023
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
"sphinx.ext.viewcode",
"sphinx.ext.extlinks",
"sphinx.ext.intersphinx",
"sphinx_autodoc_typehints",
"reno.sphinxext",
"sphinx_design",
"matplotlib.sphinxext.plot_directive",
Expand Down Expand Up @@ -85,6 +84,13 @@
# documentation created by autosummary uses a template file (in autosummary in the templates path),
# which likely overrides the autodoc defaults.

# 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"

autosummary_generate = True
autosummary_generate_overwrite = False
autoclass_content = "both"
3 changes: 1 addition & 2 deletions requirements-dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@ pylatexenc>=1.4
ddt>=1.2.0,!=1.4.0,!=1.4.3
seaborn>=0.9.0
reno>=3.4.0
Sphinx>=3.0.0
Sphinx>=5.0
qiskit-sphinx-theme>=1.6
sphinx-autodoc-typehints==1.21.1 # revert to >=1.18 once the incompatibilities are fixed
sphinx-design>=0.2.0
pygments>=2.4
scikit-learn>=0.20.0
Expand Down