From b5663bf33c04c345996ac0247ee949c71662a2d1 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 5 Nov 2024 12:42:44 -0700 Subject: [PATCH 01/25] Update conf.py --- docs/sphinx/source/conf.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 6ee5a5a1c3..a6fd6c156c 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -61,6 +61,11 @@ mathjax3_config = {'chtml': {'displayAlign': 'left', 'displayIndent': '2em'}} +# Enable hover tooltips for glossary terms +hoverxref_roles = [ + 'term', +] + napoleon_use_rtype = False # group rtype on same line together with return # Add any paths that contain templates here, relative to this directory. From b9c3ffa76f0e0b717538a4e3041ffeabc9a7e0b0 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 5 Nov 2024 13:21:11 -0700 Subject: [PATCH 02/25] example/test --- pvlib/irradiance.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pvlib/irradiance.py b/pvlib/irradiance.py index 1a3ac5e71e..cecba6237b 100644 --- a/pvlib/irradiance.py +++ b/pvlib/irradiance.py @@ -244,7 +244,7 @@ def beam_component(surface_tilt, surface_azimuth, solar_zenith, solar_azimuth, solar_azimuth : numeric Solar azimuth angle. dni : numeric - Direct Normal Irradiance + Direct normal irradiance, see :term:`dni`. [Wm⁻²] Returns ------- From 4e37b5aa68532220c6f4ad93e74a8acc123ed2f7 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 5 Nov 2024 15:21:51 -0700 Subject: [PATCH 03/25] Update readthedocs.yml --- readthedocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/readthedocs.yml b/readthedocs.yml index 280a4637e6..bcba7d1096 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -21,3 +21,4 @@ python: path: . extra_requirements: - doc + - sphinx-hoverxref From f4f434a6b74bbbc4ef30119d6110b92b6d56c8ac Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 5 Nov 2024 15:51:26 -0700 Subject: [PATCH 04/25] undo --- readthedocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/readthedocs.yml b/readthedocs.yml index bcba7d1096..280a4637e6 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -21,4 +21,3 @@ python: path: . extra_requirements: - doc - - sphinx-hoverxref From 6e086d975bb84ff5eadc993bf2b4d3324a14c549 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 5 Nov 2024 15:56:53 -0700 Subject: [PATCH 05/25] add extension to conf.py --- docs/sphinx/source/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index a6fd6c156c..346f9ab017 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -56,6 +56,7 @@ 'sphinx_gallery.gen_gallery', 'sphinx_toggleprompt', 'sphinx_favicon', + 'hoverxref.extension', ] mathjax3_config = {'chtml': {'displayAlign': 'left', From b255ce9f23c12721602f2254665242fbdb741992 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 5 Nov 2024 16:07:10 -0700 Subject: [PATCH 06/25] Update readthedocs.yml --- readthedocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/readthedocs.yml b/readthedocs.yml index 280a4637e6..a9c5c28c4f 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -21,3 +21,4 @@ python: path: . extra_requirements: - doc + - hoverxref From e9055c10c5f21e7a5b0cbf108f680e4d9fe6b27e Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 5 Nov 2024 16:17:08 -0700 Subject: [PATCH 07/25] Update readthedocs.yml --- readthedocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/readthedocs.yml b/readthedocs.yml index a9c5c28c4f..280a4637e6 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -21,4 +21,3 @@ python: path: . extra_requirements: - doc - - hoverxref From 7694a2c247d411bbf874539bdb0179916502b646 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 5 Nov 2024 16:17:29 -0700 Subject: [PATCH 08/25] ci/requirements --- ci/requirements-py3.10.yml | 1 + ci/requirements-py3.11.yml | 1 + ci/requirements-py3.12.yml | 1 + ci/requirements-py3.9-min.yml | 1 + ci/requirements-py3.9.yml | 3 ++- 5 files changed, 6 insertions(+), 1 deletion(-) diff --git a/ci/requirements-py3.10.yml b/ci/requirements-py3.10.yml index fcb89d2e7f..6c931c44b5 100644 --- a/ci/requirements-py3.10.yml +++ b/ci/requirements-py3.10.yml @@ -26,3 +26,4 @@ dependencies: - pip: - nrel-pysam>=2.0 - solarfactors + - hoverxref diff --git a/ci/requirements-py3.11.yml b/ci/requirements-py3.11.yml index f6556ecf94..faa5ce0812 100644 --- a/ci/requirements-py3.11.yml +++ b/ci/requirements-py3.11.yml @@ -26,3 +26,4 @@ dependencies: - pip: - nrel-pysam>=2.0 - solarfactors + - hoverxref diff --git a/ci/requirements-py3.12.yml b/ci/requirements-py3.12.yml index f3d8fc2d0c..ea9b5a5e05 100644 --- a/ci/requirements-py3.12.yml +++ b/ci/requirements-py3.12.yml @@ -25,4 +25,5 @@ dependencies: - statsmodels - pip: - nrel-pysam>=2.0 + - hoverxref # - solarfactors # required shapely<2 isn't available for 3.12 diff --git a/ci/requirements-py3.9-min.yml b/ci/requirements-py3.9-min.yml index d17df337fd..1d142b8a1e 100644 --- a/ci/requirements-py3.9-min.yml +++ b/ci/requirements-py3.9-min.yml @@ -19,3 +19,4 @@ dependencies: - pytest-rerunfailures # conda version is >3.6 - pytest-remotedata # conda package is 0.3.0, needs > 0.3.1 - requests-mock + - hoverxref diff --git a/ci/requirements-py3.9.yml b/ci/requirements-py3.9.yml index b5aa976b4b..e4a22ac6f2 100644 --- a/ci/requirements-py3.9.yml +++ b/ci/requirements-py3.9.yml @@ -25,4 +25,5 @@ dependencies: - statsmodels - pip: - nrel-pysam>=2.0 - - solarfactors \ No newline at end of file + - solarfactors + - hoverxref From c038966aa36895298a0671e1828d561fe5f55911 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 5 Nov 2024 16:25:27 -0700 Subject: [PATCH 09/25] undo --- ci/requirements-py3.10.yml | 1 - ci/requirements-py3.11.yml | 1 - ci/requirements-py3.12.yml | 1 - ci/requirements-py3.9-min.yml | 1 - ci/requirements-py3.9.yml | 1 - 5 files changed, 5 deletions(-) diff --git a/ci/requirements-py3.10.yml b/ci/requirements-py3.10.yml index 6c931c44b5..fcb89d2e7f 100644 --- a/ci/requirements-py3.10.yml +++ b/ci/requirements-py3.10.yml @@ -26,4 +26,3 @@ dependencies: - pip: - nrel-pysam>=2.0 - solarfactors - - hoverxref diff --git a/ci/requirements-py3.11.yml b/ci/requirements-py3.11.yml index faa5ce0812..f6556ecf94 100644 --- a/ci/requirements-py3.11.yml +++ b/ci/requirements-py3.11.yml @@ -26,4 +26,3 @@ dependencies: - pip: - nrel-pysam>=2.0 - solarfactors - - hoverxref diff --git a/ci/requirements-py3.12.yml b/ci/requirements-py3.12.yml index ea9b5a5e05..f3d8fc2d0c 100644 --- a/ci/requirements-py3.12.yml +++ b/ci/requirements-py3.12.yml @@ -25,5 +25,4 @@ dependencies: - statsmodels - pip: - nrel-pysam>=2.0 - - hoverxref # - solarfactors # required shapely<2 isn't available for 3.12 diff --git a/ci/requirements-py3.9-min.yml b/ci/requirements-py3.9-min.yml index 1d142b8a1e..d17df337fd 100644 --- a/ci/requirements-py3.9-min.yml +++ b/ci/requirements-py3.9-min.yml @@ -19,4 +19,3 @@ dependencies: - pytest-rerunfailures # conda version is >3.6 - pytest-remotedata # conda package is 0.3.0, needs > 0.3.1 - requests-mock - - hoverxref diff --git a/ci/requirements-py3.9.yml b/ci/requirements-py3.9.yml index e4a22ac6f2..42ee2113da 100644 --- a/ci/requirements-py3.9.yml +++ b/ci/requirements-py3.9.yml @@ -26,4 +26,3 @@ dependencies: - pip: - nrel-pysam>=2.0 - solarfactors - - hoverxref From 32c1ab8235977ca76a4c1615c69bde77cc64422a Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 5 Nov 2024 16:34:27 -0700 Subject: [PATCH 10/25] Update requirements-py3.9.yml --- ci/requirements-py3.9.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/requirements-py3.9.yml b/ci/requirements-py3.9.yml index 42ee2113da..b5aa976b4b 100644 --- a/ci/requirements-py3.9.yml +++ b/ci/requirements-py3.9.yml @@ -25,4 +25,4 @@ dependencies: - statsmodels - pip: - nrel-pysam>=2.0 - - solarfactors + - solarfactors \ No newline at end of file From 08ff721586da595fc4848bd5dcdd4b7cf2cedb3b Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 5 Nov 2024 16:48:42 -0700 Subject: [PATCH 11/25] (try again) installing hoverxref --- readthedocs.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/readthedocs.yml b/readthedocs.yml index 280a4637e6..a2e3f260c2 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -21,3 +21,7 @@ python: path: . extra_requirements: - doc + - method: pip + path: . + extra_requirements: + - hoverxref From 07d866205850292114f1b7cfa11799c266c48945 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Tue, 5 Nov 2024 16:56:31 -0700 Subject: [PATCH 12/25] add dependency --- pyproject.toml | 1 + readthedocs.yml | 4 ---- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index f8283a42eb..8464b7ce23 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -66,6 +66,7 @@ doc = [ 'sphinx-toggleprompt == 0.5.2', 'sphinx-favicon', 'solarfactors', + 'sphinx-hoverxref', ] test = [ 'pytest', diff --git a/readthedocs.yml b/readthedocs.yml index a2e3f260c2..280a4637e6 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -21,7 +21,3 @@ python: path: . extra_requirements: - doc - - method: pip - path: . - extra_requirements: - - hoverxref From 6b59eb05ebca038e506d96d81ee5c6d4143ccbfc Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Fri, 8 Nov 2024 18:39:11 -0700 Subject: [PATCH 13/25] Update conf.py --- docs/sphinx/source/conf.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 346f9ab017..73602f5871 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -62,10 +62,11 @@ mathjax3_config = {'chtml': {'displayAlign': 'left', 'displayIndent': '2em'}} -# Enable hover tooltips for glossary terms -hoverxref_roles = [ - 'term', -] +# # Enable hover tooltips for glossary terms +# hoverxref_roles = [ +# 'term', +# ] +hoverxref_auto_ref = True # enable hoverxref for all roles napoleon_use_rtype = False # group rtype on same line together with return From f4275b81c78dace07264493d2f95e44e6e19f3e6 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Fri, 8 Nov 2024 18:48:16 -0700 Subject: [PATCH 14/25] enable tooltip for multiple roles --- docs/sphinx/source/conf.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 73602f5871..797cdcd328 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -62,11 +62,14 @@ mathjax3_config = {'chtml': {'displayAlign': 'left', 'displayIndent': '2em'}} -# # Enable hover tooltips for glossary terms -# hoverxref_roles = [ -# 'term', -# ] -hoverxref_auto_ref = True # enable hoverxref for all roles +# Enable hover tooltips +hoverxref_roles = [ + 'term', + 'ref', + 'func', + 'class', + 'meth', +] napoleon_use_rtype = False # group rtype on same line together with return From e3878aab2e32fdb2f3baf2933b08508611637ea7 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Fri, 8 Nov 2024 19:03:41 -0700 Subject: [PATCH 15/25] add py --- docs/sphinx/source/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 797cdcd328..cc6cd321ea 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -66,9 +66,9 @@ hoverxref_roles = [ 'term', 'ref', - 'func', - 'class', - 'meth', + 'py:func', + 'py:class', + 'py:meth', ] napoleon_use_rtype = False # group rtype on same line together with return From 5a6a4206253c8f6e249a3b5da39f4ccde1301827 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Fri, 8 Nov 2024 19:11:20 -0700 Subject: [PATCH 16/25] add autoref (again) --- docs/sphinx/source/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index cc6cd321ea..b8974f6ad6 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -63,6 +63,7 @@ 'displayIndent': '2em'}} # Enable hover tooltips +hoverxref_auto_ref = True hoverxref_roles = [ 'term', 'ref', From d4a0241a122e14b60d9101d20ada47fced2c8d64 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Sat, 9 Nov 2024 10:37:14 -0700 Subject: [PATCH 17/25] Update docs/sphinx/source/conf.py Co-authored-by: Echedey Luis <80125792+echedey-ls@users.noreply.github.com> --- docs/sphinx/source/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index b8974f6ad6..6b8093b7e3 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -67,9 +67,9 @@ hoverxref_roles = [ 'term', 'ref', - 'py:func', - 'py:class', - 'py:meth', + 'func', + 'class', + 'meth', ] napoleon_use_rtype = False # group rtype on same line together with return From 6ea834fb2663fbe8d71fd271278d615a09262671 Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Sat, 9 Nov 2024 10:44:22 -0700 Subject: [PATCH 18/25] Revert "Update docs/sphinx/source/conf.py" This reverts commit d4a0241a122e14b60d9101d20ada47fced2c8d64. --- docs/sphinx/source/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 6b8093b7e3..b8974f6ad6 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -67,9 +67,9 @@ hoverxref_roles = [ 'term', 'ref', - 'func', - 'class', - 'meth', + 'py:func', + 'py:class', + 'py:meth', ] napoleon_use_rtype = False # group rtype on same line together with return From 0c7c6c48ddad98803a9c78d1a3eb5df7ca8d860a Mon Sep 17 00:00:00 2001 From: RDaxini <143435106+RDaxini@users.noreply.github.com> Date: Sat, 9 Nov 2024 10:45:44 -0700 Subject: [PATCH 19/25] Reapply "Update docs/sphinx/source/conf.py" This reverts commit 6ea834fb2663fbe8d71fd271278d615a09262671. --- docs/sphinx/source/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index b8974f6ad6..6b8093b7e3 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -67,9 +67,9 @@ hoverxref_roles = [ 'term', 'ref', - 'py:func', - 'py:class', - 'py:meth', + 'func', + 'class', + 'meth', ] napoleon_use_rtype = False # group rtype on same line together with return From a76aa291c2b287a0290b08f01acc3e8f13d0988d Mon Sep 17 00:00:00 2001 From: RDaxini Date: Thu, 14 Nov 2024 08:55:31 -0700 Subject: [PATCH 20/25] try hoverxref_domains --- docs/sphinx/source/conf.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 6b8093b7e3..c9abd72a51 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -67,6 +67,8 @@ hoverxref_roles = [ 'term', 'ref', +] +hoverxref_domains = [ 'func', 'class', 'meth', From 5c8b48b9b1d6dd6f94bb5935699260a6be8d0776 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Thu, 14 Nov 2024 09:04:23 -0700 Subject: [PATCH 21/25] try py: --- docs/sphinx/source/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index c9abd72a51..a536d6c861 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -69,9 +69,9 @@ 'ref', ] hoverxref_domains = [ - 'func', - 'class', - 'meth', + 'py:func', + 'py:class', + 'py:meth', ] napoleon_use_rtype = False # group rtype on same line together with return From b88ac2d7e0672579d407eeeb4bd1a1bfe3a473b8 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Thu, 14 Nov 2024 09:14:08 -0700 Subject: [PATCH 22/25] Update conf.py --- docs/sphinx/source/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index a536d6c861..c9abd72a51 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -69,9 +69,9 @@ 'ref', ] hoverxref_domains = [ - 'py:func', - 'py:class', - 'py:meth', + 'func', + 'class', + 'meth', ] napoleon_use_rtype = False # group rtype on same line together with return From f0d813d9a296f45d539491fa12535c7ae157e146 Mon Sep 17 00:00:00 2001 From: RDaxini Date: Thu, 14 Nov 2024 09:16:25 -0700 Subject: [PATCH 23/25] Update conf.py --- docs/sphinx/source/conf.py | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index c9abd72a51..cb62ca325b 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -64,15 +64,9 @@ # Enable hover tooltips hoverxref_auto_ref = True -hoverxref_roles = [ - 'term', - 'ref', -] -hoverxref_domains = [ - 'func', - 'class', - 'meth', -] +hoverxref_roles = ["class", "meth", "func", "ref", "term"] +hoverxref_role_types = dict.fromkeys(hoverxref_roles, "tooltip") +hoverxref_domains = ["py"] napoleon_use_rtype = False # group rtype on same line together with return From 2bea5117fdb2ebc9e64a18bf44939d2b9b0d6f9c Mon Sep 17 00:00:00 2001 From: RDaxini Date: Thu, 14 Nov 2024 09:39:08 -0700 Subject: [PATCH 24/25] intersphinx mapping --- docs/sphinx/source/conf.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index cb62ca325b..42fa072ac7 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -57,16 +57,28 @@ 'sphinx_toggleprompt', 'sphinx_favicon', 'hoverxref.extension', + 'sphinx.ext.intersphinx', ] mathjax3_config = {'chtml': {'displayAlign': 'left', 'displayIndent': '2em'}} +# used with hoverxref to link to other projects' documentation not hosted by +# readthedocs +intersphinx_mapping = { + "python": ("https://docs.python.org/3/", None), + "sphinx": ("https://www.sphinx-doc.org/en/master/", None), + "numpy": ("https://numpy.org/doc/stable", None), + "scipy": ("https://docs.scipy.org/doc/scipy", None), + "matplotlib": ("https://matplotlib.org/stable/", None), +} + # Enable hover tooltips hoverxref_auto_ref = True hoverxref_roles = ["class", "meth", "func", "ref", "term"] hoverxref_role_types = dict.fromkeys(hoverxref_roles, "tooltip") hoverxref_domains = ["py"] +hoverxref_intersphinx = list(intersphinx_mapping.keys()) napoleon_use_rtype = False # group rtype on same line together with return From d41ad64544ebee4561b0212734c716b5c1b62aed Mon Sep 17 00:00:00 2001 From: RDaxini Date: Thu, 14 Nov 2024 15:52:29 -0700 Subject: [PATCH 25/25] remove duplicate intersphinx --- docs/sphinx/source/conf.py | 23 ++++++----------------- 1 file changed, 6 insertions(+), 17 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 42fa072ac7..157e77074a 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -57,20 +57,18 @@ 'sphinx_toggleprompt', 'sphinx_favicon', 'hoverxref.extension', - 'sphinx.ext.intersphinx', ] mathjax3_config = {'chtml': {'displayAlign': 'left', 'displayIndent': '2em'}} -# used with hoverxref to link to other projects' documentation not hosted by -# readthedocs +# Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - "python": ("https://docs.python.org/3/", None), - "sphinx": ("https://www.sphinx-doc.org/en/master/", None), - "numpy": ("https://numpy.org/doc/stable", None), - "scipy": ("https://docs.scipy.org/doc/scipy", None), - "matplotlib": ("https://matplotlib.org/stable/", None), + 'python': ('https://docs.python.org/3/', None), + 'numpy': ('https://numpy.org/doc/stable/', None), + 'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None), + 'pandas': ('https://pandas.pydata.org/pandas-docs/stable', None), + 'matplotlib': ('https://matplotlib.org/stable', None), } # Enable hover tooltips @@ -376,15 +374,6 @@ def setup(app): # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - 'python': ('https://docs.python.org/3/', None), - 'numpy': ('https://numpy.org/doc/stable/', None), - 'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None), - 'pandas': ('https://pandas.pydata.org/pandas-docs/stable', None), - 'matplotlib': ('https://matplotlib.org/stable', None), -} - ipython_warning_is_error = False # suppress "WARNING: Footnote [1] is not referenced." messages