search

sagemath / sage

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

autodoc: use __qualname__ on Python 3 #27002

Closed jdemeyer closed 5 years ago

jdemeyer commented 5 years ago

This takes one change from upstream Sphinx autodoc: using __qualname__ to document aliases.

To work around https://github.com/cython/cython/pull/2773 we use this only on Python 3.

Upstream: Fixed upstream, but not in a stable release.

CC: @kwankyu

Component: documentation

Author: Kwankyu Lee

Branch/Commit: b628d1c

Reviewer: Jeroen Demeyer

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

jdemeyer commented 5 years ago

Description changed:

--- 
+++ 
@@ -1 +1,3 @@
+This takes one change from upstream Sphinx autodoc: using `__qualname__` to document aliases.

+To work around https://github.com/cython/cython/pull/2773 we use this only on Python 3.
jdemeyer commented 5 years ago

Branch: u/jdemeyer/autodocuse__qualnameon_python_3

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 5 years ago

Commit: b628d1c

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 5 years ago

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

b628d1cMakes sage autodoc work for both py2 and py3
jdemeyer commented 5 years ago

Upstream: Fixed upstream, but not in a stable release.

jdemeyer commented 5 years ago

Reviewer: Jeroen Demeyer

embray commented 5 years ago
comment:7

Retarging tickets optimistically to the next milestone. If you are responsible for this ticket (either its reporter or owner) and don't believe you are likely to complete this ticket before the next release (8.7) please retarget this ticket's milestone to sage-pending or sage-wishlist.

vbraun commented 5 years ago

Changed branch from u/jdemeyer/autodocuse__qualnameon_python_3 to b628d1c