Cleanup, rename static & templates to _static & _templates

NREL · Nov 8, 2024 · 0a5886a · 0a5886a
1 parent 9862dc4
commit 0a5886a
Show file tree

Hide file tree

Showing 17 changed files with 17 additions and 17 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -29,22 +29,24 @@ on:
 jobs:
   lint:
     name: (Lint ${{ matrix.python-version }}, ${{ matrix.os }})
-
     runs-on: ${{ matrix.os }}
 
     strategy:
       fail-fast: false
       matrix:
-        os: ['ubuntu-latest']
+        os: [ubuntu-latest]
         python-version: ['3.13']
 
     defaults:
       run: 
         shell: bash -l {0}
 
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup python
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 

diff --git a/docs/source/static/api_reference.svg → docs/source/_static/api_reference.svg b/docs/source/static/api_reference.svg → docs/source/_static/api_reference.svg
diff --git a/docs/source/static/custom.css → docs/source/_static/custom.css b/docs/source/static/custom.css → docs/source/_static/custom.css
diff --git a/docs/source/static/custom.js → docs/source/_static/custom.js b/docs/source/static/custom.js → docs/source/_static/custom.js
diff --git a/docs/source/static/dark.png → docs/source/_static/dark.png b/docs/source/static/dark.png → docs/source/_static/dark.png
diff --git a/docs/source/static/dark_tag.png → docs/source/_static/dark_tag.png b/docs/source/static/dark_tag.png → docs/source/_static/dark_tag.png
diff --git a/docs/source/static/development.svg → docs/source/_static/development.svg b/docs/source/static/development.svg → docs/source/_static/development.svg
diff --git a/docs/source/static/examples.svg → docs/source/_static/examples.svg b/docs/source/static/examples.svg → docs/source/_static/examples.svg
diff --git a/docs/source/static/favicon.ico → docs/source/_static/favicon.ico b/docs/source/static/favicon.ico → docs/source/_static/favicon.ico
diff --git a/docs/source/static/icons.svg → docs/source/_static/icons.svg b/docs/source/static/icons.svg → docs/source/_static/icons.svg
diff --git a/docs/source/static/light.png → docs/source/_static/light.png b/docs/source/static/light.png → docs/source/_static/light.png
diff --git a/docs/source/static/light_tag.png → docs/source/_static/light_tag.png b/docs/source/static/light_tag.png → docs/source/_static/light_tag.png
diff --git a/docs/source/static/user_guide.svg → docs/source/_static/user_guide.svg b/docs/source/static/user_guide.svg → docs/source/_static/user_guide.svg
diff --git a/docs/source/templates/navbar-logo.html → docs/source/_templates/navbar-logo.html b/docs/source/templates/navbar-logo.html → docs/source/_templates/navbar-logo.html
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -30,7 +30,7 @@
     'sphinx_copybutton',
 ]
 
-templates_path = ['templates']
+templates_path = ['_templates']
 
 exclude_patterns = [
     'build',
@@ -58,14 +58,12 @@
 # html_favicon = 'static/favicon.ico'
 html_context = {'default_mode': 'dark'}
 
-html_static_path = ['static']
+html_static_path = ['_static']
 html_js_files = ['custom.js']
 html_css_files = ['custom.css']
 
 html_sidebars = {'index': [], '**': ['sidebar-nav-bs']}
 
-html_logo = None
-
 html_theme_options = {
     # 'logo': {
     #     'image_light': 'static/light.png',
@@ -86,8 +84,8 @@
     'navbar_start': ['navbar-logo'],
     'navbar_align': 'content',
     'header_links_before_dropdown': 5,
-    'footer_start': ['copyright.html'],
-    'footer_end': ['sphinx-version.html'],
+    'footer_start': ['copyright'],
+    'footer_end': ['sphinx-version'],
     'navbar_persistent': ['search-button-field'],
     'primary_sidebar_end': ['sidebar-ethical-ads'],
     'secondary_sidebar_items': ['page-toc'],

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -68,7 +68,7 @@ DAEs with no algebraic constraints).
          Access installation instructions and in-depth
          information on solver concepts and settings.
 
-         .. image:: static/user_guide.svg
+         .. image:: _static/user_guide.svg
             :class: bg-transparent
             :align: center
             :height: 75px
@@ -88,7 +88,7 @@ DAEs with no algebraic constraints).
       Get detailed documentation on all of the modules,
       functions, classes, etc.
 
-      .. image:: static/api_reference.svg
+      .. image:: _static/api_reference.svg
          :class: bg-transparent
          :align: center
          :height: 75px
@@ -108,7 +108,7 @@ DAEs with no algebraic constraints).
          A great place to learn how to use the package and
          expand your skills.
 
-         .. image:: static/examples.svg
+         .. image:: _static/examples.svg
             :class: bg-transparent
             :align: center
             :height: 75px
@@ -128,7 +128,7 @@ DAEs with no algebraic constraints).
       Trying to fix a typo in the documentation? Looking
       to improve or add a new feature?
 
-      .. image:: static/development.svg
+      .. image:: _static/development.svg
          :class: bg-transparent
          :align: center
          :height: 75px

diff --git a/noxfile.py b/noxfile.py
@@ -56,7 +56,7 @@ def run_codespell(session):
 @nox.session(name='spellcheck', python=False)
 def run_spellcheck(session):
     """
-    Run codespell with some docs files indcluded
+    Run codespell with docs files included
 
     Use the optional 'write' argument to write the corrections directly into
     the files. Otherwise, you will only see a summary of the found errors.
@@ -152,8 +152,8 @@ def run_pre_commit(session):
     """
     Run all linters/tests and make new badges
 
-    Order of sessions: flake8, codespell, pytest, genbade. Using 'write' for
-    codespell and/or 'parallel' for pytest is permitted.
+    Order of sessions: flake8, codespell, pytest, genbade. Using 'format' for
+    linter, 'write' for codespell, and/or 'parallel' for pytest is permitted.
 
     """