mirrors/rocm_jax
1
0
Fork 0
mirror of https://github.com/ROCm/jax.git synced 2025-04-14 10:56:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove dependency on sphinx_autodoc_typehints

Browse Source
This commit is contained in:
Jake VanderPlas 2024-04-29 14:19:46 -07:00
parent b44e9bfe66
commit 55e3be65b7
3 changed files with 3 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.readthedocs.yml
View File

@ -8,7 +8,7 @@ version: 2
build: build:
os: "ubuntu-22.04" os: "ubuntu-22.04"
tools: tools:
python: "3.9" python: "3.10"
# Build documentation in the docs/ directory with Sphinx # Build documentation in the docs/ directory with Sphinx
sphinx: sphinx:

9
docs/conf.py
View File

@ -67,7 +67,6 @@ extensions = [
'sphinx.ext.napoleon', 'sphinx.ext.napoleon',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'matplotlib.sphinxext.plot_directive', 'matplotlib.sphinxext.plot_directive',
'sphinx_autodoc_typehints',
'myst_nb', 'myst_nb',
"sphinx_remove_toctrees", "sphinx_remove_toctrees",
'sphinx_copybutton', 'sphinx_copybutton',
@ -294,17 +293,13 @@ epub_exclude_files = ['search.html']
# -- Extension configuration ------------------------------------------------- # -- Extension configuration -------------------------------------------------
# Tell sphinx-autodoc-typehints to generate stub parameter annotations including
# types, even if the parameters aren't explicitly documented.
always_document_param_types = True
# Tell sphinx autodoc how to render type aliases. # Tell sphinx autodoc how to render type aliases.
autodoc_typehints = "description"
autodoc_typehints_description_target = "all"
autodoc_type_aliases = { autodoc_type_aliases = {
'ArrayLike': 'jax.typing.ArrayLike', 'ArrayLike': 'jax.typing.ArrayLike',
'DTypeLike': 'jax.typing.DTypeLike', 'DTypeLike': 'jax.typing.DTypeLike',
} }
# Remove auto-generated API docs from sidebars. They take too long to build. # Remove auto-generated API docs from sidebars. They take too long to build.
remove_from_toctrees = ["_autosummary/*"] remove_from_toctrees = ["_autosummary/*"]

1
docs/requirements.txt
View File

@ -1,7 +1,6 @@
absl-py absl-py
ipython>=8.8.0 # 8.7.0 has ipython3 lexer error ipython>=8.8.0 # 8.7.0 has ipython3 lexer error
sphinx>=7.3.2 # 7.3.0 breaks sphinx-book-theme sphinx>=7.3.2 # 7.3.0 breaks sphinx-book-theme
sphinx-autodoc-typehints
sphinx-book-theme>=1.0.1 # Older versions fail to pin pydata-sphinx-theme sphinx-book-theme>=1.0.1 # Older versions fail to pin pydata-sphinx-theme
sphinx-copybutton>=0.5.0 sphinx-copybutton>=0.5.0
sphinx-remove-toctrees sphinx-remove-toctrees