Opened 12 months ago

Last modified 3 months ago

#30894 new enhancement

Add typing info to documentation using sphinx_autodoc_typehints

Reported by: gh-tobiasdiez Owned by:
Priority: major Milestone: sage-9.5
Component: documentation Keywords:
Cc: mkoeppe Merged in:
Authors: Reviewers:
Report Upstream: N/A Work issues: Add sphinx_autodoc_typehints package to sage
Branch: public/documentation/addtyping (Commits, GitHub, GitLab) Commit: e26a88ba10f161e6e352d69e2c8d0d84b983d11e
Dependencies: Stopgaps:

Status badges

Description

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.

Change History (3)

comment:1 in reply to: ↑ description Changed 12 months ago by mkoeppe

Replying to gh-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

comment:2 Changed 9 months ago by mkoeppe

  • Milestone changed from sage-9.3 to sage-9.4

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

comment:3 Changed 3 months ago by mkoeppe

  • Milestone changed from sage-9.4 to sage-9.5
Note: See TracTickets for help on using tickets.