From 2514b8b63ca5f2c2a99213aeb77ba0c03380783b Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 02:10:40 +0200 Subject: [PATCH 01/38] Initial version bump --- pyproject.toml | 8 ++++---- readthedocs.yml | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index de51b7c22c..5c6596ddcc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -57,12 +57,12 @@ optional = [ doc = [ 'ipython', 'matplotlib', - 'sphinx == 4.5.0', - 'pydata-sphinx-theme == 0.8.1', + 'sphinx == 7.3', + 'pydata-sphinx-theme == 0.15', 'sphinx-gallery', - 'docutils == 0.15.2', + 'docutils == 0.21', 'pillow', - 'sphinx-toggleprompt >= 0.0.5', + 'sphinx-toggleprompt == 0.5', 'solarfactors', ] test = [ diff --git a/readthedocs.yml b/readthedocs.yml index 2aa95e6866..b5c318cc56 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -8,7 +8,7 @@ version: 2 build: os: ubuntu-20.04 tools: - python: "3.8" + python: "3.9" jobs: # fetch the full history so that setuptools_scm can determine the # correct version string for long PRs with many commits From 3da9e04a45ae5bb821eeb147d85780bb1b6a0c26 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 02:16:45 +0200 Subject: [PATCH 02/38] Pin latests, okay --- pyproject.toml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 5c6596ddcc..a202783444 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -57,12 +57,12 @@ optional = [ doc = [ 'ipython', 'matplotlib', - 'sphinx == 7.3', - 'pydata-sphinx-theme == 0.15', + 'sphinx == 7.3.7', + 'pydata-sphinx-theme == 0.15.4', 'sphinx-gallery', 'docutils == 0.21', 'pillow', - 'sphinx-toggleprompt == 0.5', + 'sphinx-toggleprompt == 0.5.2', 'solarfactors', ] test = [ From 598f535dd401929d7e524a8f84c203f48a34e002 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 02:30:59 +0200 Subject: [PATCH 03/38] Update extlinks See sphinx#11094 --- docs/sphinx/source/conf.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 9c0d90990e..e9d6376a5f 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -296,12 +296,12 @@ def setup(app): # extlinks alias extlinks = { - 'issue': ('https://github.com/pvlib/pvlib-python/issues/%s', 'GH'), - 'pull': ('https://github.com/pvlib/pvlib-python/pull/%s', 'GH'), - 'wiki': ('https://github.com/pvlib/pvlib-python/wiki/%s', 'wiki '), - 'doi': ('http://dx.doi.org/%s', 'DOI: '), - 'ghuser': ('https://github.com/%s', '@'), - 'discuss': ('https://github.com/pvlib/pvlib-python/discussions/%s', 'GH'), + 'issue': ('https://github.com/pvlib/pvlib-python/issues/%s', 'GH%s'), + 'pull': ('https://github.com/pvlib/pvlib-python/pull/%s', 'GH%s'), + 'wiki': ('https://github.com/pvlib/pvlib-python/wiki/%s', 'wiki %s'), + 'doi': ('http://dx.doi.org/%s', 'DOI: %s'), + 'ghuser': ('https://github.com/%s', '@%s'), + 'discuss': ('https://github.com/pvlib/pvlib-python/discussions/%s', 'GH%s'), } # -- Options for manual page output --------------------------------------- From c95b440cc6d658d7cdba25ff1ec8d0decead65a2 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 02:56:13 +0200 Subject: [PATCH 04/38] add entries to html_context, from pydata sphinx theme --- docs/sphinx/source/conf.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index e9d6376a5f..70b913ba64 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -472,4 +472,8 @@ def make_github_url(file_name): html_context = { 'make_github_url': make_github_url, 'edit_page_url_template': '{{ make_github_url(file_name) }}', + "github_user": "pvlib", + "github_repo": "pvlib-python", + "github_version": "main", + "doc_path": "docs/sphinx", } From 7fb8bc902cf811b8834ea90668303d3b04c36653 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 02:59:03 +0200 Subject: [PATCH 05/38] Update edit-this-page.html --- docs/sphinx/source/_templates/edit-this-page.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/_templates/edit-this-page.html b/docs/sphinx/source/_templates/edit-this-page.html index 66a09f1e2c..0f3e1d7683 100644 --- a/docs/sphinx/source/_templates/edit-this-page.html +++ b/docs/sphinx/source/_templates/edit-this-page.html @@ -12,7 +12,7 @@ {% if sourcename is defined and theme_use_edit_page_button==true and page_source_suffix %} {% set src = sourcename.split('.') %}
- + {{ _("View on GitHub") }}
From 6705e8d5511eb30cde6e95b128c51afb913c2bae Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 03:04:15 +0200 Subject: [PATCH 06/38] Update edit-this-page.html --- docs/sphinx/source/_templates/edit-this-page.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/_templates/edit-this-page.html b/docs/sphinx/source/_templates/edit-this-page.html index 0f3e1d7683..08fc5e1619 100644 --- a/docs/sphinx/source/_templates/edit-this-page.html +++ b/docs/sphinx/source/_templates/edit-this-page.html @@ -12,7 +12,7 @@ {% if sourcename is defined and theme_use_edit_page_button==true and page_source_suffix %} {% set src = sourcename.split('.') %}
- + {{ _("View on GitHub") }}
From 748b81a6a69547ad1515318c50055f01d4d7b3ae Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 03:06:18 +0200 Subject: [PATCH 07/38] Update conf.py --- docs/sphinx/source/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 70b913ba64..eee33cbe29 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -470,8 +470,8 @@ def make_github_url(file_name): # variables to pass into the HTML templating engine; these are accessible from # _templates/breadcrumbs.html html_context = { - 'make_github_url': make_github_url, - 'edit_page_url_template': '{{ make_github_url(file_name) }}', + # 'make_github_url': make_github_url, + # 'edit_page_url_template': '{{ make_github_url(file_name) }}', "github_user": "pvlib", "github_repo": "pvlib-python", "github_version": "main", From ae080e6d2f86ade572d0024d15b3e06c308974e6 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 03:07:30 +0200 Subject: [PATCH 08/38] Update conf.py --- docs/sphinx/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index eee33cbe29..1352228326 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -162,7 +162,7 @@ "icon": "fab fa-python", }, ], - "use_edit_page_button": True, + "use_edit_page_button": False, "show_toc_level": 1, "footer_items": ["copyright", "sphinx-version", "sidebar-ethical-ads"], "left_sidebar_end": [], From a62390de495487f1512e561d730ab82c19fffca4 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 03:19:29 +0200 Subject: [PATCH 09/38] Footer warning --- docs/sphinx/source/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 1352228326..cd21ea95fc 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -164,7 +164,9 @@ ], "use_edit_page_button": False, "show_toc_level": 1, - "footer_items": ["copyright", "sphinx-version", "sidebar-ethical-ads"], + "footer_start": ["copyright"], + "footer_center": ["sphinx-version"], + "footer_end": ["sidebar-ethical-ads"], "left_sidebar_end": [], } From bafaccac04fe3ac2790d7176572bcdd95664c49a Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 03:22:00 +0200 Subject: [PATCH 10/38] `"left_sidebar_end"` -> `"primary_sidebar_end"` --- docs/sphinx/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index cd21ea95fc..cefa2f9039 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -167,7 +167,7 @@ "footer_start": ["copyright"], "footer_center": ["sphinx-version"], "footer_end": ["sidebar-ethical-ads"], - "left_sidebar_end": [], + "primary_sidebar_end": [], } # Add any paths that contain custom themes here, relative to this directory. From 45ca25aeebcf35e8823262c9b028f8846930e4b7 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 03:29:29 +0200 Subject: [PATCH 11/38] Add favicons --- docs/sphinx/source/conf.py | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index cefa2f9039..86c573f22d 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -24,6 +24,7 @@ # https://github.com/pypa/setuptools/issues/3044 import distutils # noqa: F401 import pandas as pd + pd.show_versions() # If extensions (or modules to document with autodoc) are in another directory, @@ -54,6 +55,7 @@ 'IPython.sphinxext.ipython_console_highlighting', 'sphinx_gallery.gen_gallery', 'sphinx_toggleprompt', + 'sphinx_favicon', ] mathjax3_config = {'chtml': {'displayAlign': 'left', @@ -82,7 +84,7 @@ # |version| and |release|, also used in various other places throughout the # built documents. -import pvlib +import pvlib # noqa: E402 # The short X.Y version. version = '%s' % (pvlib.__version__) @@ -144,7 +146,6 @@ "favicons": [ {"rel": "icon", "sizes": "16x16", "href": "favicon-16x16.png"}, {"rel": "icon", "sizes": "32x32", "href": "favicon-32x32.png"}, - ], "icon_links": [ { "name": "StackOverflow", @@ -170,6 +171,13 @@ "primary_sidebar_end": [], } +# Add favicons from extension sphinx_favicon +favicons = [ + {"rel": "icon", "sizes": "16x16", "href": "favicon-16x16.png"}, + {"rel": "icon", "sizes": "32x32", "href": "favicon-32x32.png"}, +] + + # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] From 5932951f825f6b034bd5a37010e40e3c14c1fffc Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 03:29:46 +0200 Subject: [PATCH 12/38] Add favicons dependency --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index a202783444..1209cbba54 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -63,6 +63,7 @@ doc = [ 'docutils == 0.21', 'pillow', 'sphinx-toggleprompt == 0.5.2', + 'sphinx-favicon', 'solarfactors', ] test = [ From 34988f3e3b1d3872688c5de8acf437a06983b5a0 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 03:30:41 +0200 Subject: [PATCH 13/38] GH desktop is a bit broken --- docs/sphinx/source/conf.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 86c573f22d..bdf4ca6b7d 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -143,9 +143,6 @@ # https://pydata-sphinx-theme.rtfd.io/en/latest/user_guide/configuring.html html_theme_options = { "github_url": "https://github.com/pvlib/pvlib-python", - "favicons": [ - {"rel": "icon", "sizes": "16x16", "href": "favicon-16x16.png"}, - {"rel": "icon", "sizes": "32x32", "href": "favicon-32x32.png"}, "icon_links": [ { "name": "StackOverflow", From e07c67207ed96875516f5af740b712311823829e Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 03:42:12 +0200 Subject: [PATCH 14/38] linter --- docs/sphinx/source/conf.py | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index bdf4ca6b7d..2465d28795 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -176,7 +176,7 @@ # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -303,12 +303,15 @@ def setup(app): # extlinks alias extlinks = { - 'issue': ('https://github.com/pvlib/pvlib-python/issues/%s', 'GH%s'), - 'pull': ('https://github.com/pvlib/pvlib-python/pull/%s', 'GH%s'), - 'wiki': ('https://github.com/pvlib/pvlib-python/wiki/%s', 'wiki %s'), - 'doi': ('http://dx.doi.org/%s', 'DOI: %s'), - 'ghuser': ('https://github.com/%s', '@%s'), - 'discuss': ('https://github.com/pvlib/pvlib-python/discussions/%s', 'GH%s'), + "issue": ("https://github.com/pvlib/pvlib-python/issues/%s", "GH%s"), + "pull": ("https://github.com/pvlib/pvlib-python/pull/%s", "GH%s"), + "wiki": ("https://github.com/pvlib/pvlib-python/wiki/%s", "wiki %s"), + "doi": ("http://dx.doi.org/%s", "DOI: %s"), + "ghuser": ("https://github.com/%s", "@%s"), + "discuss": ( + "https://github.com/pvlib/pvlib-python/discussions/%s", + "GH%s", + ), } # -- Options for manual page output --------------------------------------- From c996dd5e8a4631e17fd59ef5cc6b43bcd157d562 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 12:14:20 +0200 Subject: [PATCH 15/38] Edit link (I?) --- .../source/_templates/edit-this-page.html | 19 ------------------- docs/sphinx/source/conf.py | 1 + 2 files changed, 1 insertion(+), 19 deletions(-) delete mode 100644 docs/sphinx/source/_templates/edit-this-page.html diff --git a/docs/sphinx/source/_templates/edit-this-page.html b/docs/sphinx/source/_templates/edit-this-page.html deleted file mode 100644 index 08fc5e1619..0000000000 --- a/docs/sphinx/source/_templates/edit-this-page.html +++ /dev/null @@ -1,19 +0,0 @@ -{# - -Modify the "Edit on Github" links to handle auto-generated pages in the -example gallery and the API reference listings. The GH links that sphinx -generates by default make the assumption that an HTML file comes from an RST -file with the same filepath, which isn't the case for autogenerated files. The -logic to generate the correct URL is in conf.py, but we still have to modify -the template here to change the "Edit this page" text to "View on GitHub". - -#} - -{% if sourcename is defined and theme_use_edit_page_button==true and page_source_suffix %} -{% set src = sourcename.split('.') %} -
- - {{ _("View on GitHub") }} - -
-{% endif %} diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 2465d28795..402536228a 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -482,6 +482,7 @@ def make_github_url(file_name): html_context = { # 'make_github_url': make_github_url, # 'edit_page_url_template': '{{ make_github_url(file_name) }}', + "github_url": "https://github.com", "github_user": "pvlib", "github_repo": "pvlib-python", "github_version": "main", From 2d889c5652480209871bcd6be9a4a593ac484dde Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 12:23:22 +0200 Subject: [PATCH 16/38] `"use_edit_page_button": True,` else I can't test it xd --- docs/sphinx/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 402536228a..d31d09bab3 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -160,7 +160,7 @@ "icon": "fab fa-python", }, ], - "use_edit_page_button": False, + "use_edit_page_button": True, "show_toc_level": 1, "footer_start": ["copyright"], "footer_center": ["sphinx-version"], From 1ecdfc81237aea73cc722a928f541e36fe34dccf Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 12:39:56 +0200 Subject: [PATCH 17/38] Add `edit-this-page.html` again --- .../source/_templates/edit-this-page.html | 19 +++++++++++++++++++ docs/sphinx/source/conf.py | 6 +++--- 2 files changed, 22 insertions(+), 3 deletions(-) create mode 100644 docs/sphinx/source/_templates/edit-this-page.html diff --git a/docs/sphinx/source/_templates/edit-this-page.html b/docs/sphinx/source/_templates/edit-this-page.html new file mode 100644 index 0000000000..40df1e84a8 --- /dev/null +++ b/docs/sphinx/source/_templates/edit-this-page.html @@ -0,0 +1,19 @@ +{# + +Modify the "Edit on Github" links to handle auto-generated pages in the +example gallery and the API reference listings. The GH links that sphinx +generates by default make the assumption that an HTML file comes from an RST +file with the same filepath, which isn't the case for autogenerated files. The +logic to generate the correct URL is in conf.py, but we still have to modify +the template here to change the "Edit this page" text to "View on GitHub". + +#} + +{% if sourcename is defined and theme_use_edit_page_button==true and page_source_suffix %} +{% set src = sourcename.split('.') %} +
+ + {{ _("View on GitHub") }} + +
+{% endif %} diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index d31d09bab3..e63ed1e272 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -480,11 +480,11 @@ def make_github_url(file_name): # variables to pass into the HTML templating engine; these are accessible from # _templates/breadcrumbs.html html_context = { - # 'make_github_url': make_github_url, - # 'edit_page_url_template': '{{ make_github_url(file_name) }}', + 'make_github_url': make_github_url, + 'edit_page_url_template': '{{ make_github_url(file_name) }}', "github_url": "https://github.com", "github_user": "pvlib", "github_repo": "pvlib-python", "github_version": "main", - "doc_path": "docs/sphinx", + "doc_path": "docs/sphinx/source/", } From 8f4a7b00ccb8ea24b4bf7376fa12d191ddc7c322 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 12:45:54 +0200 Subject: [PATCH 18/38] `html_show_sourcelink = False` --- docs/sphinx/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index e63ed1e272..12aec32269 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -229,7 +229,7 @@ #html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True From 5e72776a4c5dcab81cd461fca866d96f8e20fcda Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 12:47:00 +0200 Subject: [PATCH 19/38] Update conf.py --- docs/sphinx/source/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 12aec32269..2e3a829712 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -226,13 +226,13 @@ #html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. html_show_copyright = False From 8daa10aca12400b3076cf5714c11e5cc8950e216 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 12:53:36 +0200 Subject: [PATCH 20/38] this was unnecessary --- docs/sphinx/source/conf.py | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 2e3a829712..90c76ee485 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -482,9 +482,4 @@ def make_github_url(file_name): html_context = { 'make_github_url': make_github_url, 'edit_page_url_template': '{{ make_github_url(file_name) }}', - "github_url": "https://github.com", - "github_user": "pvlib", - "github_repo": "pvlib-python", - "github_version": "main", - "doc_path": "docs/sphinx/source/", } From 4175be53a5c20e5c851d0f7b62c8c184f6ef7ccb Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 12:56:17 +0200 Subject: [PATCH 21/38] Update edit-this-page.html https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/source-buttons.html#custom-link-text --- docs/sphinx/source/_templates/edit-this-page.html | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/docs/sphinx/source/_templates/edit-this-page.html b/docs/sphinx/source/_templates/edit-this-page.html index 40df1e84a8..30ebd491b0 100644 --- a/docs/sphinx/source/_templates/edit-this-page.html +++ b/docs/sphinx/source/_templates/edit-this-page.html @@ -9,11 +9,6 @@ #} -{% if sourcename is defined and theme_use_edit_page_button==true and page_source_suffix %} -{% set src = sourcename.split('.') %} -
- - {{ _("View on GitHub") }} - -
-{% endif %} +{% block edit_this_page_text %} + View on GitHub +{% endblock %} From ec96670e0ef3939e9d9c9313579f34246b9e01ad Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 13:01:51 +0200 Subject: [PATCH 22/38] Revert "Update edit-this-page.html" This reverts commit 4175be53a5c20e5c851d0f7b62c8c184f6ef7ccb. --- docs/sphinx/source/_templates/edit-this-page.html | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/_templates/edit-this-page.html b/docs/sphinx/source/_templates/edit-this-page.html index 30ebd491b0..40df1e84a8 100644 --- a/docs/sphinx/source/_templates/edit-this-page.html +++ b/docs/sphinx/source/_templates/edit-this-page.html @@ -9,6 +9,11 @@ #} -{% block edit_this_page_text %} - View on GitHub -{% endblock %} +{% if sourcename is defined and theme_use_edit_page_button==true and page_source_suffix %} +{% set src = sourcename.split('.') %} +
+ + {{ _("View on GitHub") }} + +
+{% endif %} From 6148b605252f7b8b800d37288b1f2e8e977b4d99 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 13:02:31 +0200 Subject: [PATCH 23/38] Update conf.py --- docs/sphinx/source/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 90c76ee485..6cf7506cc7 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -481,5 +481,4 @@ def make_github_url(file_name): # _templates/breadcrumbs.html html_context = { 'make_github_url': make_github_url, - 'edit_page_url_template': '{{ make_github_url(file_name) }}', } From de30ed863d396442bd63ec31b352f1781f53bf8f Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 13:05:18 +0200 Subject: [PATCH 24/38] Suppress warnings See numpy#25504 --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 1209cbba54..16b39c3b64 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -56,6 +56,7 @@ optional = [ ] doc = [ 'ipython', + 'pickleshare', # required by ipython 'matplotlib', 'sphinx == 7.3.7', 'pydata-sphinx-theme == 0.15.4', From 6a6dcd60aa46e8d0761f8fe77e67f0cab0a0689e Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 13:13:16 +0200 Subject: [PATCH 25/38] Revert back to original --- docs/sphinx/source/_templates/edit-this-page.html | 2 +- docs/sphinx/source/conf.py | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/source/_templates/edit-this-page.html b/docs/sphinx/source/_templates/edit-this-page.html index 40df1e84a8..dd1ac5abbe 100644 --- a/docs/sphinx/source/_templates/edit-this-page.html +++ b/docs/sphinx/source/_templates/edit-this-page.html @@ -12,7 +12,7 @@ {% if sourcename is defined and theme_use_edit_page_button==true and page_source_suffix %} {% set src = sourcename.split('.') %}
- + {{ _("View on GitHub") }}
diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 6cf7506cc7..90c76ee485 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -481,4 +481,5 @@ def make_github_url(file_name): # _templates/breadcrumbs.html html_context = { 'make_github_url': make_github_url, + 'edit_page_url_template': '{{ make_github_url(file_name) }}', } From e89753cdafa2cc4a27cc2fa488b16b0be618073c Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 13:19:39 +0200 Subject: [PATCH 26/38] Did I already try this? --- docs/sphinx/source/_templates/edit-this-page.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/_templates/edit-this-page.html b/docs/sphinx/source/_templates/edit-this-page.html index dd1ac5abbe..40df1e84a8 100644 --- a/docs/sphinx/source/_templates/edit-this-page.html +++ b/docs/sphinx/source/_templates/edit-this-page.html @@ -12,7 +12,7 @@ {% if sourcename is defined and theme_use_edit_page_button==true and page_source_suffix %} {% set src = sourcename.split('.') %}
- + {{ _("View on GitHub") }}
From ae9e23cabc51b1cdfe67fc607cf016062c6a29cc Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 14:45:50 +0200 Subject: [PATCH 27/38] Using the docs --- docs/sphinx/source/_templates/edit-this-page.html | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/sphinx/source/_templates/edit-this-page.html b/docs/sphinx/source/_templates/edit-this-page.html index 40df1e84a8..f482f8a2d4 100644 --- a/docs/sphinx/source/_templates/edit-this-page.html +++ b/docs/sphinx/source/_templates/edit-this-page.html @@ -9,11 +9,8 @@ #} -{% if sourcename is defined and theme_use_edit_page_button==true and page_source_suffix %} -{% set src = sourcename.split('.') %} -
- - {{ _("View on GitHub") }} - -
-{% endif %} +{% extends "!components/edit-this-page.html" %} + +{% block edit_this_page_text %} + Edit on GitHub +{% endblock %} From d85cd42132acf886c1f6f2d86a52eb4f90fe9229 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 14:57:31 +0200 Subject: [PATCH 28/38] Fix the edit -> view on github --- docs/sphinx/source/_templates/edit-this-page.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/_templates/edit-this-page.html b/docs/sphinx/source/_templates/edit-this-page.html index f482f8a2d4..0e70e0b2de 100644 --- a/docs/sphinx/source/_templates/edit-this-page.html +++ b/docs/sphinx/source/_templates/edit-this-page.html @@ -12,5 +12,5 @@ {% extends "!components/edit-this-page.html" %} {% block edit_this_page_text %} - Edit on GitHub + View on GitHub {% endblock %} From 36273de449e78bdfc1c8f28a20bf30f07aa7310f Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 15:22:35 +0200 Subject: [PATCH 29/38] linter --- docs/sphinx/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 90c76ee485..0a50e9127d 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -223,7 +223,7 @@ #html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. # html_split_index = False From 04f14c7a1a40635ba408067dddf5fc1c253a1b19 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 29 Jun 2024 15:30:12 +0200 Subject: [PATCH 30/38] No way linter --- docs/sphinx/source/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 0a50e9127d..cd0c06bfb4 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -217,10 +217,10 @@ # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. # html_use_index = True From 590310b1da994fc738824e22c85cabc15a68b89b Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sun, 30 Jun 2024 18:47:49 +0200 Subject: [PATCH 31/38] Fix references formatting Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com> --- docs/sphinx/source/_static/reference_format.css | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/docs/sphinx/source/_static/reference_format.css b/docs/sphinx/source/_static/reference_format.css index bdfa5661b8..8ebabc4848 100644 --- a/docs/sphinx/source/_static/reference_format.css +++ b/docs/sphinx/source/_static/reference_format.css @@ -1,13 +1,5 @@ /* no reference superscript */ .footnote-reference { - font-size: 100% !important; /* default is 90% */ - top: 0.0em !important; /* default is -0.4em */ -} - -/* reference number in brackets */ -.footnote-reference::before { - content: '['; -} -.footnote-reference::after { - content: ']'; + font-size: 100% !important; + vertical-align: baseline !important; } From 0da9f06ed3f026a1e54fa9be340aba9454784242 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Mon, 1 Jul 2024 19:22:47 +0200 Subject: [PATCH 32/38] Remove prev/next links Co-Authored-By: Kevin Anderson <57452607+kandersolar@users.noreply.github.com> Co-Authored-By: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com> Co-Authored-By: RDaxini <143435106+RDaxini@users.noreply.github.com> Co-Authored-By: Cliff Hansen <5393711+cwhanse@users.noreply.github.com> --- docs/sphinx/source/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index cd0c06bfb4..dfe28015ad 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -166,7 +166,9 @@ "footer_center": ["sphinx-version"], "footer_end": ["sidebar-ethical-ads"], "primary_sidebar_end": [], -} + # https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/layout.html#hide-the-previous-and-next-buttons + "show_prev_next": False, # disable next/previous links +} # noqa: E501 # Add favicons from extension sphinx_favicon favicons = [ From aaf521ccffef9c645e32c9dfca54b59c12b91d55 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Fri, 5 Jul 2024 16:40:24 +0200 Subject: [PATCH 33/38] Delay updating docs build env in the future Co-Authored-By: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com> --- readthedocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readthedocs.yml b/readthedocs.yml index b5c318cc56..280a4637e6 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -6,9 +6,9 @@ version: 2 build: - os: ubuntu-20.04 + os: ubuntu-lts-latest tools: - python: "3.9" + python: "3.11" jobs: # fetch the full history so that setuptools_scm can determine the # correct version string for long PRs with many commits From d94d807c4d74b1ee579933712036743206c139b5 Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Fri, 5 Jul 2024 18:31:57 +0200 Subject: [PATCH 34/38] Copyright Co-Authored-By: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com> --- docs/sphinx/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 9a80c753e4..39747ba588 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -237,7 +237,7 @@ # html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -html_show_copyright = False +# html_show_copyright = False # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the From 849ac5687f4ecde3882f4cc08db87724206f919e Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Fri, 5 Jul 2024 21:51:52 +0200 Subject: [PATCH 35/38] Fix empty sidebar not collapsing (I hope) Co-Authored-By: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com> --- docs/sphinx/source/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 39747ba588..9b1bebca68 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -215,7 +215,9 @@ #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -# html_sidebars = {} +html_sidebars = { + "**": ["sidebar-nav-bs"] +} # Additional templates that should be rendered to pages, maps page names to # template names. From 97d46605884bc323c4b22228aa59ea5783255dba Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 13 Jul 2024 11:14:45 +0200 Subject: [PATCH 36/38] Stylize navigation and footer per Adam comment Co-Authored-By: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com> --- docs/sphinx/source/conf.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 9b1bebca68..9ef46c7771 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -162,9 +162,9 @@ ], "use_edit_page_button": True, "show_toc_level": 1, - "footer_start": ["copyright"], - "footer_center": ["sphinx-version"], - "footer_end": ["sidebar-ethical-ads"], + # "footer_start": [], # "copyright", "sphinx-version" + # "footer_center": [], + "footer_end": [], "primary_sidebar_end": [], # https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/layout.html#hide-the-previous-and-next-buttons "show_prev_next": False, # disable next/previous links @@ -215,9 +215,9 @@ #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -html_sidebars = { - "**": ["sidebar-nav-bs"] -} +# html_sidebars = { +# "**": ["sidebar-nav-bs"] +# } # Additional templates that should be rendered to pages, maps page names to # template names. From ca2457bad7b82a5c49ad75cd073477b27cd546ef Mon Sep 17 00:00:00 2001 From: echedey-ls <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 13 Jul 2024 11:31:51 +0200 Subject: [PATCH 37/38] linter on diff F --- 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 9ef46c7771..9af9d3c542 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -204,15 +204,15 @@ # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -#html_extra_path = [] +# html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. # html_sidebars = { From 218f3e7ac70fd27829a823843b535e7c9d65bc5e Mon Sep 17 00:00:00 2001 From: Echedey Luis <80125792+echedey-ls@users.noreply.github.com> Date: Sat, 13 Jul 2024 13:46:14 +0200 Subject: [PATCH 38/38] Update docs/sphinx/source/conf.py Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com> --- docs/sphinx/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 9af9d3c542..116a3bb09c 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -165,7 +165,7 @@ # "footer_start": [], # "copyright", "sphinx-version" # "footer_center": [], "footer_end": [], - "primary_sidebar_end": [], + # "primary_sidebar_end": [], # https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/layout.html#hide-the-previous-and-next-buttons "show_prev_next": False, # disable next/previous links } # noqa: E501