From d9aeced20422726937d6578d02ff4b2531c1a641 Mon Sep 17 00:00:00 2001 From: takanori-pskq Date: Mon, 2 Nov 2020 01:39:09 +0000 Subject: [PATCH 1/5] DOC: Modify Templates --- doc/source/_templates/autosummary/attribute.rst | 6 +++++- doc/source/_templates/autosummary/base.rst | 6 +++++- doc/source/_templates/autosummary/member.rst | 5 ++++- doc/source/_templates/autosummary/method.rst | 6 +++++- 4 files changed, 19 insertions(+), 4 deletions(-) diff --git a/doc/source/_templates/autosummary/attribute.rst b/doc/source/_templates/autosummary/attribute.rst index a6ed600ef7b9..e3845c7fe3f1 100644 --- a/doc/source/_templates/autosummary/attribute.rst +++ b/doc/source/_templates/autosummary/attribute.rst @@ -6,5 +6,9 @@ attribute -.. auto{{ objtype }}:: {{ objname }} +.. auto{{ objtype }}:: {{ fullname | replace("numpy.", "numpy::") }} + +{# In the fullname (e.g. `numpy.ma.MaskedArray.methodname`), the module name +is anbiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`) +specifies `numpy` as the module name. #} diff --git a/doc/source/_templates/autosummary/base.rst b/doc/source/_templates/autosummary/base.rst index 0331154a7cf6..630b115a0663 100644 --- a/doc/source/_templates/autosummary/base.rst +++ b/doc/source/_templates/autosummary/base.rst @@ -10,5 +10,9 @@ property {% endif %} -.. auto{{ objtype }}:: {{ objname }} +.. auto{{ objtype }}:: {{ fullname | replace("numpy.", "numpy::") }} + +{# In the fullname (e.g. `numpy.ma.MaskedArray.methodname`), the module name +is anbiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`) +specifies `numpy` as the module name. #} diff --git a/doc/source/_templates/autosummary/member.rst b/doc/source/_templates/autosummary/member.rst index f1f30e12385e..85591877ec01 100644 --- a/doc/source/_templates/autosummary/member.rst +++ b/doc/source/_templates/autosummary/member.rst @@ -6,6 +6,9 @@ member -.. auto{{ objtype }}:: {{ objname }} +.. auto{{ objtype }}:: {{ fullname | replace("numpy.", "numpy::") }} +{# In the fullname (e.g. `numpy.ma.MaskedArray.methodname`), the module name +is anbiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`) +specifies `numpy` as the module name. #} diff --git a/doc/source/_templates/autosummary/method.rst b/doc/source/_templates/autosummary/method.rst index 8abda8677cf4..1cc2d2a7068c 100644 --- a/doc/source/_templates/autosummary/method.rst +++ b/doc/source/_templates/autosummary/method.rst @@ -6,5 +6,9 @@ method -.. auto{{ objtype }}:: {{ objname }} +.. auto{{ objtype }}:: {{ fullname | replace("numpy.", "numpy::") }} + +{# In the fullname (e.g. `numpy.ma.MaskedArray.methodname`), the module name +is anbiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`) +specifies `numpy` as the module name. #} From 91ee20652a27e942f24a1034a80d0c0ef65d7728 Mon Sep 17 00:00:00 2001 From: Takanori H Date: Wed, 4 Nov 2020 19:56:47 +0900 Subject: [PATCH 2/5] Update doc/source/_templates/autosummary/attribute.rst Co-authored-by: Matti Picus --- doc/source/_templates/autosummary/attribute.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/source/_templates/autosummary/attribute.rst b/doc/source/_templates/autosummary/attribute.rst index e3845c7fe3f1..9e0eaa25fdfb 100644 --- a/doc/source/_templates/autosummary/attribute.rst +++ b/doc/source/_templates/autosummary/attribute.rst @@ -9,6 +9,5 @@ attribute .. auto{{ objtype }}:: {{ fullname | replace("numpy.", "numpy::") }} {# In the fullname (e.g. `numpy.ma.MaskedArray.methodname`), the module name -is anbiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`) +is ambiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`) specifies `numpy` as the module name. #} - From 6c05d7a89d7c0a9db4d8e12500a26a8d71f8647f Mon Sep 17 00:00:00 2001 From: Takanori H Date: Wed, 4 Nov 2020 19:56:55 +0900 Subject: [PATCH 3/5] Update doc/source/_templates/autosummary/base.rst Co-authored-by: Matti Picus --- doc/source/_templates/autosummary/base.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/source/_templates/autosummary/base.rst b/doc/source/_templates/autosummary/base.rst index 630b115a0663..91bfff9ba870 100644 --- a/doc/source/_templates/autosummary/base.rst +++ b/doc/source/_templates/autosummary/base.rst @@ -13,6 +13,5 @@ property .. auto{{ objtype }}:: {{ fullname | replace("numpy.", "numpy::") }} {# In the fullname (e.g. `numpy.ma.MaskedArray.methodname`), the module name -is anbiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`) +is ambiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`) specifies `numpy` as the module name. #} - From 080980a83b20c8c009bf60705371a7a4c63074cf Mon Sep 17 00:00:00 2001 From: Takanori H Date: Wed, 4 Nov 2020 19:57:01 +0900 Subject: [PATCH 4/5] Update doc/source/_templates/autosummary/member.rst Co-authored-by: Matti Picus --- doc/source/_templates/autosummary/member.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/source/_templates/autosummary/member.rst b/doc/source/_templates/autosummary/member.rst index 85591877ec01..c0dcd5ed2676 100644 --- a/doc/source/_templates/autosummary/member.rst +++ b/doc/source/_templates/autosummary/member.rst @@ -9,6 +9,5 @@ member .. auto{{ objtype }}:: {{ fullname | replace("numpy.", "numpy::") }} {# In the fullname (e.g. `numpy.ma.MaskedArray.methodname`), the module name -is anbiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`) +is ambiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`) specifies `numpy` as the module name. #} - From d97b91a25ae1177ea83ff1e75348a88f37c96724 Mon Sep 17 00:00:00 2001 From: Takanori H Date: Wed, 4 Nov 2020 19:57:09 +0900 Subject: [PATCH 5/5] Update doc/source/_templates/autosummary/method.rst Co-authored-by: Matti Picus --- doc/source/_templates/autosummary/method.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/source/_templates/autosummary/method.rst b/doc/source/_templates/autosummary/method.rst index 1cc2d2a7068c..0dd2263932c6 100644 --- a/doc/source/_templates/autosummary/method.rst +++ b/doc/source/_templates/autosummary/method.rst @@ -9,6 +9,5 @@ method .. auto{{ objtype }}:: {{ fullname | replace("numpy.", "numpy::") }} {# In the fullname (e.g. `numpy.ma.MaskedArray.methodname`), the module name -is anbiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`) +is ambiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`) specifies `numpy` as the module name. #} -