sagemath / sage

Main repository of SageMath
https://www.sagemath.org
Other
1.36k stars 462 forks source link

Add typing info to documentation using sphinx_autodoc_typehints #30894

Open tobiasdiez opened 3 years ago

tobiasdiez commented 3 years ago

The purpose of this ticket is to add typing information to the documentation using the sphinx_autodoc_typehints extension.

I would like to ask for help/instructions on how to add the pip-installable package sphinx_autodoc_typehints to sage.

CC: @mkoeppe

Component: documentation

Work Issues: Add sphinx_autodoc_typehints package to sage

Branch/Commit: public/documentation/addtyping @ e26a88b

Issue created by migration from https://trac.sagemath.org/ticket/30894

mkoeppe commented 3 years ago

Replying to @tobiasdiez:

I would like to ask for help/instructions on how to add the pip-installable package sphinx_autodoc_typehints to sage.

https://doc.sagemath.org/html/en/developer/packaging.html

Or just copy build/pkgs/sphinxcontrib_htmlhelp and adjust

mkoeppe commented 3 years ago
comment:2

Setting new milestone based on a cursory review of ticket status, priority, and last modification date.