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.

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

Add typing info to documentation using sphinx_autodoc_typehints #30894

Open
tobiasdiez opened this issue Nov 11, 2020 · 2 comments
Open

Add typing info to documentation using sphinx_autodoc_typehints #30894

tobiasdiez opened this issue Nov 11, 2020 · 2 comments

Comments

@tobiasdiez
Copy link
Contributor

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
Copy link
Contributor

mkoeppe commented Nov 11, 2020

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
Copy link
Contributor

mkoeppe commented Feb 13, 2021

comment:2

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

@mkoeppe mkoeppe modified the milestones: sage-9.3, sage-9.4 Feb 13, 2021
@mkoeppe mkoeppe modified the milestones: sage-9.4, sage-9.5 Jul 19, 2021
@mkoeppe mkoeppe modified the milestones: sage-9.5, sage-9.6 Dec 14, 2021
@mkoeppe mkoeppe modified the milestones: sage-9.6, sage-9.7 Mar 5, 2022
@mkoeppe mkoeppe modified the milestones: sage-9.7, sage-9.8 Aug 31, 2022
@mkoeppe mkoeppe modified the milestones: sage-9.8, sage-9.9 Jan 7, 2023
@mkoeppe mkoeppe removed this from the sage-10.0 milestone Mar 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants