Merge pull request #25 from pyfar/new-cookiecutter

fix

Author: ahms5

.circleci/config.yml

@@ -171,36 +171,36 @@ workflows:
                 - "3.11"
                 - "3.12"
                 - "3.13"
-                
+
       - ruff:
           matrix:
             parameters:
               version:
-                - "3.9"
+                - "3.12"
           requires:
             - build_and_test
 
       - test_documentation_build:
           matrix:
             parameters:
               version:
-                - "3.9"
+                - "3.12"
           requires:
             - build_and_test
 
       - test_deprecation_warnings:
           matrix:
             parameters:
               version:
-                - "3.9"
+                - "3.12"
           requires:
             - build_and_test
 
       - test_pypi_publish:
           matrix:
             parameters:
               version:
-                - "3.9"
+                - "3.12"
           requires:
             - build_and_test
 
@@ -218,7 +218,7 @@ workflows:
                 - "3.11"
                 - "3.12"
                 - "3.13"
-                
+
           filters:
             branches:
               ignore: /.*/
@@ -230,7 +230,7 @@ workflows:
           matrix:
             parameters:
               version:
-                - "3.9"
+                - "3.12"
           requires:
             - build_and_test
           filters:
@@ -244,7 +244,7 @@ workflows:
           matrix:
             parameters:
               version:
-                - "3.9"
+                - "3.12"
           requires:
             - build_and_test
           filters:
@@ -258,7 +258,7 @@ workflows:
           matrix:
             parameters:
               version:
-                - "3.9"
+                - "3.12"
           requires:
             - build_and_test
           filters:
@@ -272,7 +272,7 @@ workflows:
           matrix:
             parameters:
               version:
-                - "3.9"
+                - "3.12"
           requires:
             - build_and_test
             - ruff

.gitignore

@@ -121,3 +121,4 @@ docs/_static/favicon.ico
 docs/_static/header.rst
 docs/_static/css/custom.css
 docs/resources/logos/pyfar_logos_fixed_size_imkar.png
+docs/resources/logos/pyfar_logos_fixed_size_pyfar.png

docs/conf.py

@@ -117,7 +117,7 @@
     "navbar_start": ["navbar-logo"],
     "navbar_end": ["navbar-icon-links", "theme-switcher"],
     "navbar_align": "content",
-    "header_links_before_dropdown": 8,
+    "header_links_before_dropdown": 10,
     "icon_links": [
         {
           "name": "GitHub",
@@ -144,6 +144,17 @@
 }
 
 # -- download navbar and style files from gallery -----------------------------
+def download_files_from_gallery(link, folders_in):
+    c = urllib3.PoolManager()
+    for file in folders_in:
+        url = link + file
+        filename = file
+        os.makedirs(os.path.dirname(filename), exist_ok=True)
+        with c.request('GET', url, preload_content=False) as res:
+            if res.status == 200:
+                with open(filename, 'wb') as out_file:
+                    shutil.copyfileobj(res, out_file)
+
 branch = 'main'
 link = f'https://github.com/pyfar/gallery/raw/{branch}/docs/'
 folders_in = [
@@ -152,23 +163,21 @@
     '_static/header.rst',
     'resources/logos/pyfar_logos_fixed_size_imkar.png',
     ]
-c = urllib3.PoolManager()
-for file in folders_in:
-    url = link + file
-    filename = file
-    os.makedirs(os.path.dirname(filename), exist_ok=True)
-    with c.request('GET', url, preload_content=False) as res, open(filename, 'wb') as out_file:
-        shutil.copyfileobj(res, out_file)
+download_files_from_gallery(link, folders_in)
+# if logo does not exist, use pyfar logo
+if not os.path.exists(html_logo):
+    download_files_from_gallery(
+        link, ['resources/logos/pyfar_logos_fixed_size_pyfar.png'])
+    shutil.copyfile(
+        'resources/logos/pyfar_logos_fixed_size_pyfar.png', html_logo)
 
 # replace imkar hard link to internal link
 with open("_static/header.rst", "rt") as fin:
     with open("header.rst", "wt") as fout:
-        contains_imkar = False
-        for line in fin:
-            line_new = line.replace(f'https://{project}.readthedocs.io', project)
-            if line_new != line:
-                contains_imkar = True
-            fout.write(line_new)
-        if not contains_imkar:
-            fout.write(f'   {project} <{project}>\n')
+        lines = [line.replace(f'https://{project}.readthedocs.io', project) for line in fin]
+        contains_project = any(project in line for line in lines)
 
+        fout.writelines(lines)
+
+        if not contains_project:
+            fout.write(f'   {project} <{project}>\n')

pyproject.toml

@@ -48,7 +48,7 @@ tests = [
     "pytest",
     "pytest-cov",
     "watchdog",
-    "ruff==0.4.1",
+    "ruff==0.8.3",
     "coverage",
 ]
 docs = [