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;
}
diff --git a/docs/sphinx/source/_templates/edit-this-page.html b/docs/sphinx/source/_templates/edit-this-page.html
index 66a09f1e2c..0e70e0b2de 100644
--- a/docs/sphinx/source/_templates/edit-this-page.html
+++ b/docs/sphinx/source/_templates/edit-this-page.html
@@ -1,7 +1,7 @@
{#
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
+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
@@ -9,11 +9,8 @@
#}
-{% if sourcename is defined and theme_use_edit_page_button==true and page_source_suffix %}
-{% set src = sourcename.split('.') %}
-
-{% endif %}
+{% extends "!components/edit-this-page.html" %}
+
+{% block edit_this_page_text %}
+ View on GitHub
+{% endblock %}
diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py
index 522d0f9ec4..116a3bb09c 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__)
@@ -141,10 +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",
@@ -164,12 +162,23 @@
],
"use_edit_page_button": True,
"show_toc_level": 1,
- "footer_items": ["copyright", "sphinx-version", "sidebar-ethical-ads"],
- "left_sidebar_end": [],
-}
+ # "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
+} # noqa: E501
+
+# 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 = []
+# html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# " v documentation".
@@ -195,40 +204,42 @@
# 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 = {}
+# html_sidebars = {
+# "**": ["sidebar-nav-bs"]
+# }
# 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
+# 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 = True
+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
+# html_show_copyright = False
# If true, an OpenSearch description file will be output, and all pages will
# contain a