finalizing the documentation details to make it actually function

Author: zerothi

.readthedocs-pre_install.sh

@@ -10,7 +10,7 @@ if [[ "${READTHEDOCS:-no}" == "no" ]]; then
 fi
 
 # Try and fetch the shallow submodule
-git submodule update --init --depth=1
+git submodule update --init --depth=1 --single-branch
 
 # Ensure we get a version that lets us use groups
 python3 -m pip install --upgrade pip

docs/conf.py

@@ -94,9 +94,10 @@
 # This can be a pure HTML (for interaction), but that tends
 # to blow up file-sizes which isn't really suitable for
 # RTD.
-plotly_renderer = "notebook_connected"
-if on_rtd:
-    plotly_renderer = "png"
+# For now, we retain the PNG as default.
+# This will limit the interaction, but
+# will make loading the page much faster!
+plotly_renderer = "png"
 plotly_renderer = os.environ.get("_SISL_DOC_PLOTLY", plotly_renderer)
 
 if "iframe" in plotly_renderer:
@@ -488,6 +489,8 @@ def has_under(name: str):
 plot_include_source = True
 plot_formats = [("png", 90)]
 plot_pre_code = f"""\
+import logging
+logging.getLogger("nodify").setLevel(logging.WARNING)
 import numpy as np
 import matplotlib.pyplot as plt
 import sisl as si

docs/dev/index.rst

@@ -68,13 +68,13 @@ Here is a short summary of how to do developments with `sisl`.
 
         .. code:: bash
 
-           git clone git@github.com:<your-username>/sisl.git
+           git clone git@github.com:<your-username>/sisl.git --single-branch
 
      .. tab:: HTML
 
         .. code:: bash
 
-           git clone https://github.com/<your-username>/sisl.git
+           git clone https://github.com/<your-username>/sisl.git --single-branch
 
      And move to the folder ``cd sisl``.
 
@@ -199,8 +199,7 @@ To contribute to the documentation one needs to install `pandoc`_ first (see
 
    .. code:: bash
 
-      git submodule init
-      git submodule update
+      git submodule update --init --single-branch
 
 #. **OPTIONAL**
 

docs/quickstart/install.rst

@@ -44,7 +44,7 @@ using :code:`pip` or :code:`conda` methods:
 
    .. code-block:: bash
 
-       git clone git+https://github.com/zerothi/sisl.git
+       git clone git+https://github.com/zerothi/sisl.git --single-branch
        cd sisl
        python3 -m pip install -e .
 
@@ -121,7 +121,7 @@ A basic procedure would be:
 
 .. code-block:: bash
 
-   git clone https://github.com/zerothi/sisl-files.git
+   git clone https://github.com/zerothi/sisl-files.git --single-branch
    SISL_FILES_TESTS=$(pwd)/sisl-files pytest --pyargs sisl