Skip to content

Commit

Permalink
Merge pull request #1728 from aucampia/iwana-20220226T2130-autodoc_ty…
Browse files Browse the repository at this point in the history
…pehints_both

Enable showing typehints in sphinx function/method signature and content
  • Loading branch information
aucampia committed Mar 14, 2022
2 parents 6bdb576 + d0cf3eb commit 1fdf40c
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 5 deletions.
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
apidoc_module_dir = "../rdflib"
apidoc_output_dir = "apidocs"
autodoc_default_options = {"special-members": True}
autodoc_typehints = "both"

autosummary_generate = True

Expand Down
4 changes: 2 additions & 2 deletions docs/sphinx-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
sphinx==4.4.0
sphinxcontrib-apidoc
git+https://github.com/gniezen/n3pygments.git
myst-parser
sphinx<5
sphinxcontrib-apidoc
sphinxcontrib-kroki
4 changes: 2 additions & 2 deletions requirements.dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ doctest-ignore-unicode==0.1.2
flake8
flake8-black
html5lib
isort
mypy
myst-parser
pytest
pytest-cov
pytest-subtests
isort
sphinx
sphinx<5
sphinxcontrib-apidoc
sphinxcontrib-kroki
types-setuptools
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
"html": ["html5lib"],
"tests": kwargs["tests_require"],
"docs": [
"myst-parser",
"sphinx < 5",
"sphinxcontrib-apidoc",
"myst-parser",
"sphinxcontrib-kroki",
],
}
Expand Down

0 comments on commit 1fdf40c

Please sign in to comment.