proof of concept

pvlib · mikofski · Dec 7, 2021 · Feb 21, 2021 · Apr 15, 2021 · Apr 16, 2021
commit e052c8f7ff844a9bd14a6f9e7c2bcb0983ebaadc
diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py
@@ -127,20 +127,21 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-# on_rtd is whether we are on readthedocs.org
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
-
-if not on_rtd:  # only import and set the theme if we're building docs locally
-    import sphinx_rtd_theme
-    html_theme = 'sphinx_rtd_theme'
-    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-else:
-    html_theme = 'default'
+html_theme = "pydata_sphinx_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+html_theme_options = {
+    #"external_links": [
+    #    {"url": "https://pandas.pydata.org/pandas-docs/stable/", "name": "Pandas Docs"}
+    #],
+    #"github_url": "https://github.com/pandas-dev/pydata-sphinx-theme",
+    #"twitter_url": "https://twitter.com/pandas_dev",
+    #"use_edit_page_button": True,
+    "show_toc_level": 1,
+    # "navbar_align": "right",  # For testing that the navbar items align properly
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []

diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst
@@ -90,21 +90,11 @@ Contents
 .. toctree::
    :maxdepth: 1
 
-   package_overview
-   introtutorial
+   user_guide/index
    auto_examples/index
+   api
    whatsnew
-   installation
    contributing
-   pvsystem
-   modelchain
-   timetimezones
-   clearsky
-   forecasts
-   api
-   comparison_pvlib_matlab
-   variables_style_rules
-   singlediode
 
 
 Indices and tables

diff --git a/docs/sphinx/source/clearsky.rst → docs/sphinx/source/user_guide/clearsky.rst b/docs/sphinx/source/clearsky.rst → docs/sphinx/source/user_guide/clearsky.rst
diff --git a/...sphinx/source/comparison_pvlib_matlab.rst → ...ce/user_guide/comparison_pvlib_matlab.rst b/...sphinx/source/comparison_pvlib_matlab.rst → ...ce/user_guide/comparison_pvlib_matlab.rst
diff --git a/docs/sphinx/source/forecasts.rst → docs/sphinx/source/user_guide/forecasts.rst b/docs/sphinx/source/forecasts.rst → docs/sphinx/source/user_guide/forecasts.rst
diff --git a/docs/sphinx/source/user_guide/index.rst b/docs/sphinx/source/user_guide/index.rst
@@ -0,0 +1,20 @@
+==========
+User Guide
+==========
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Demo Documentation
+
+   package_overview
+   installation
+   introtutorial
+   pvsystem
+   modelchain
+   timetimezones
+   clearsky
+   forecasts
+   comparison_pvlib_matlab
+   variables_style_rules
+   singlediode
diff --git a/docs/sphinx/source/installation.rst → ...sphinx/source/user_guide/installation.rst b/docs/sphinx/source/installation.rst → ...sphinx/source/user_guide/installation.rst
@@ -146,7 +146,7 @@ Follow these steps to obtain the library using git/GitHub:
    This button is circled in the image below. Remember the system path that
    you clone the library to.
 
-.. image:: _images/clonebutton.png
+.. image:: ../_images/clonebutton.png
 
 Please see GitHub's
 `Forking Projects <https://guides.github.com/activities/forking/>`_,

diff --git a/docs/sphinx/source/introtutorial.rst → ...phinx/source/user_guide/introtutorial.rst b/docs/sphinx/source/introtutorial.rst → ...phinx/source/user_guide/introtutorial.rst
diff --git a/docs/sphinx/source/modelchain.rst → docs/sphinx/source/user_guide/modelchain.rst b/docs/sphinx/source/modelchain.rst → docs/sphinx/source/user_guide/modelchain.rst
diff --git a/docs/sphinx/source/package_overview.rst → ...nx/source/user_guide/package_overview.rst b/docs/sphinx/source/package_overview.rst → ...nx/source/user_guide/package_overview.rst
diff --git a/docs/sphinx/source/pvsystem.rst → docs/sphinx/source/user_guide/pvsystem.rst b/docs/sphinx/source/pvsystem.rst → docs/sphinx/source/user_guide/pvsystem.rst
diff --git a/docs/sphinx/source/singlediode.rst → .../sphinx/source/user_guide/singlediode.rst b/docs/sphinx/source/singlediode.rst → .../sphinx/source/user_guide/singlediode.rst
diff --git a/docs/sphinx/source/timetimezones.rst → ...phinx/source/user_guide/timetimezones.rst b/docs/sphinx/source/timetimezones.rst → ...phinx/source/user_guide/timetimezones.rst
diff --git a/docs/sphinx/source/variables_style_rules.rst → ...urce/user_guide/variables_style_rules.rst b/docs/sphinx/source/variables_style_rules.rst → ...urce/user_guide/variables_style_rules.rst
@@ -6,7 +6,7 @@ Variables and Symbols
 There is a convention on consistent variable names throughout the library:
 
 .. csv-table:: List of used Variables and Parameters
-   :file: ../../../pvlib/data/variables_style_rules.csv
+   :file: ../../../../pvlib/data/variables_style_rules.csv
    :delim: ;
    :header-rows: 1
    :widths: 5, 5

diff --git a/setup.py b/setup.py
@@ -55,7 +55,7 @@
                  'pvfactors', 'siphon', 'statsmodels', 'tables',
                  'cftime >= 1.1.1'],
     'doc': ['ipython', 'matplotlib', 'sphinx == 3.1.2',
-            'sphinx_rtd_theme==0.5.0', 'sphinx-gallery', 'docutils == 0.15.2',
+            'pydata-sphinx-theme', 'sphinx-gallery', 'docutils == 0.15.2',
             'pillow', 'netcdf4', 'siphon', 'tables',
             'sphinx-toggleprompt >= 0.0.5'],
     'test': TESTS_REQUIRE