fix structure in sphinx and download duplicated doc files from gallery

.gitignore

@@ -124,3 +124,10 @@ pyfar/signals/files/*
 # workaround for failing test discovery in vscode
 tests/*/__init__.py
 tests/private/
+
+# ignore downloads from pyfar gallery
+docs/header.rst
+docs/_static/favicon.ico
+docs/_static/header.rst
+docs/_static/css/custom.css
+docs/resources/logos/pyfar_logos_fixed_size_pyfar.png

docs/conf.py

@@ -8,6 +8,8 @@
 
 import os
 import sys
+import urllib3
+import shutil
 sys.path.insert(0, os.path.abspath('..'))
 
 import pyfar  # noqa
@@ -26,6 +28,7 @@
     'autodocsumm',
     'sphinx_design',
     'sphinx_favicon',
+    'sphinx_reredirects',
 ]
 
 # show tocs for classes and functions of modules using the autodocsumm
@@ -107,6 +110,7 @@
     "navbar_start": ["navbar-logo"],
     "navbar_end": ["navbar-icon-links", "theme-switcher"],
     "navbar_align": "content",
+    "header_links_before_dropdown": 8,
     "icon_links": [
         {
           "name": "GitHub",
@@ -125,6 +129,34 @@
    "default_mode": "light"
 }
 
+# redirect index to pyfar.html
+redirects = {
+     "index": "pyfar.html"
+}
+
+# -- download navbar and style files from gallery -----------------------------
+branch = 'main'
+link = f'https://github.com/pyfar/gallery/raw/{branch}/docs/'
+folders_in = [
+    '_static/css/custom.css',
+    '_static/favicon.ico',
+    '_static/header.rst',
+    'resources/logos/pyfar_logos_fixed_size_pyfar.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)
+
+# replace pyfar hard link to internal link
+with open("_static/header.rst", "rt") as fin:
+    with open("header.rst", "wt") as fout:
+        for line in fin:
+            fout.write(line.replace(f'https://{project}.readthedocs.io', project))
+
 # -- pyfar specifics -----------------------------------------------------
 
 # write shortcuts to sphinx readable format

docs/index.rst

@@ -1,52 +1,2 @@
-.. |pyfar_logo| image:: resources/pyfar.png
-   :width: 150
-   :alt: Alternative text
 
-Getting Started
-===============
-
-.. toctree::
-   :maxdepth: 2
-
-   readme
-
-Documentation
-=============
-
-.. toctree::
-   :maxdepth: 2
-
-   concepts
-
-.. toctree::
-   :maxdepth: 2
-
-   classes
-
-.. toctree::
-   :maxdepth: 2
-
-   modules
-
-Contributing
-===============
-
-.. toctree::
-   :maxdepth: 1
-
-   contributing
-
-Other
-=====
-.. toctree::
-   :maxdepth: 1
-
-   history
-
-..
-   (removed because it is contained in the new spinx style)
-   Indices and tables
-   ==================
-   * :ref:`genindex`
-   * :ref:`modindex`
-   * :ref:`search`
+.. include:: header.rst

docs/pyfar.rst

@@ -0,0 +1,31 @@
+pyfar
+=====
+
+.. toctree::
+   :caption: Getting Started
+   :maxdepth: 2
+
+   readme
+
+
+.. toctree::
+   :caption: Documentation
+   :maxdepth: 2
+
+   concepts
+   classes
+   modules
+
+
+.. toctree::
+   :caption: Contributing
+   :maxdepth: 1
+
+   contributing
+
+
+.. toctree::
+   :caption: Other
+   :maxdepth: 1
+
+   history

requirements_dev.txt

@@ -20,3 +20,4 @@ sofar>=1.1.1
 pydata-sphinx-theme
 sphinx-design
 sphinx-favicon
+sphinx-reredirects