Add anchors to faqs, update python, use static sidebar due to limitat…

.github/workflows/publish.yml

@@ -1,27 +1,31 @@
 name: publish
 on:
-    push:
-        branches:
-            - main
-    repository_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - "*"
+  repository_dispatch:
 jobs:
-    publish:
-        name: Build and publish the website
-        runs-on: ubuntu-20.04
-        steps:
-            - name: Checkout the Git repository
-              uses: actions/checkout@v2
-            - name: Setup Python
-              uses: actions/setup-python@v2
-              with:
-                python-version: '3.8'
-            - name: Build website
-              run: make prod
-            - name: Sync website with the remote repository
-              uses: ./.github/actions/sync-repository
-              with:
-                local-path: dist/
-                ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
-                ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
-                ssh-port: ${{ secrets.SSH_PORT }}
-                remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web
+  publish:
+    name: Build and publish the website
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout the Git repository
+        uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.13"
+      - name: Build website
+        run: make prod
+      - name: Sync website with the remote repository
+        if: ${{ github.ref == 'refs/heads/main' }}
+        uses: ./.github/actions/sync-repository
+        with:
+          local-path: dist/
+          ssh-key: ${{ secrets.SSH_PRIVATE_KEY }}
+          ssh-known-hosts: ${{ secrets.SSH_KNOWN_HOSTS }}
+          ssh-port: ${{ secrets.SSH_PORT }}
+          remote-path: ${{ secrets.REMOTE_SSH }}:/srv/toltec/web

requirements.txt

@@ -1,29 +1,5 @@
-alabaster==0.7.12
-Babel==2.9.1
-certifi==2021.10.8
-charset-normalizer==2.0.7
-colorama==0.4.4
-docutils==0.17.1
-idna==3.3
-imagesize==1.2.0
-Jinja2==3.0.2
-livereload==2.6.3
-MarkupSafe==2.0.1
-packaging==21.0
-Pygments==2.10.0
-pyparsing==2.4.7
-pytz==2021.3
-requests==2.26.0
-six==1.16.0
-snowballstemmer==2.1.0
-Sphinx==4.2.0
-sphinx-autobuild==2021.3.14
-sphinxcontrib-applehelp==1.0.2
-sphinxcontrib-devhelp==1.0.2
+Sphinx==8.0.2
+sphinx-autobuild==2024.9.19
 sphinxcontrib-fulltoc==1.2.0
-sphinxcontrib-htmlhelp==2.0.0
+sphinxcontrib-htmlhelp==2.1.0
 sphinxcontrib-jsmath==1.0.1
-sphinxcontrib-qthelp==1.0.3
-sphinxcontrib-serializinghtml==1.1.5
-tornado==6.1
-urllib3==1.26.7

src/_themes/toltec/nav.html

@@ -1,3 +1,25 @@
 <nav class="sidebar-nav">
-    {{ toc }}
+    <ul class="current">
+        <li class="toctree-l1"><a class="reference internal" href="#install-toltec">
+                Install Toltec
+            </a></li>
+        <li class="toctree-l1"><a class="reference internal" href="#what-does-toltec-do">
+                What Does Toltec
+                Do?
+            </a></li>
+        <li class="toctree-l1"><a class="reference internal" href="#frequently-asked-questions">
+                Frequently Asked Questions
+            </a>
+        </li>
+        <li class="toctree-l1"><a class="reference external" href="https://toltec-dev.org/stable">
+                Packages
+            </a></li>
+        <li class="toctree-l1"><a class="reference external" href="https://bin.entware.net/armv7sf-k3.2/Packages.html">
+                Entware Packages
+            </a></li>
+        <li class="toctree-l1"><a class="reference external"
+                href="https://github.com/toltec-dev/toltec/releases/latest">
+                Latest Release Notes
+            </a></li>
+    </ul>
 </nav>

src/conf.py

@@ -14,7 +14,7 @@
 html_title = "Toltec"
 html_theme = "toltec"
 master_doc = "sitemap"
-html_sidebars = { "**": ["nav.html", "sidefooter.html"] }
+html_sidebars = {"**": ["nav.html", "sidefooter.html"]}
 html_permalinks_icon = "#"
 
 extensions = [

src/index.rst

@@ -86,50 +86,77 @@ Frequently Asked Questions
 ==========================
 
 Where can I get help?
-    If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
-    Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.
+---------------------
+
+If you need help with Toltec or one of its packages, you can `start a discussion on GitHub <https://github.com/toltec-dev/toltec/discussions>`_ or `join the reMarkable community on Discord <https://discord.gg/ATqQGfu>`_.
+Please do not open issues to ask for help, as they're used exclusively for `package requests <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#requesting-a-package>`_ and `bug reports <https://github.com/toltec-dev/toltec/blob/testing/docs/contributing.md#reporting-a-bug>`_.
 
 Is this supported by reMarkable AS?
-    No, this is a community project.
+-----------------------------------
+
+No, this is a community project.
 
 Will this brick my reMarkable?
-    Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.
+------------------------------
+
+Probably not, but `standard disclaimers apply <https://github.com/toltec-dev/toltec/blob/stable/LICENSE>`_.
 
 Do you support reMarkable 2?
-    Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.
+---------------------------------
+
+Yes, Toltec will automatically detect whether you are using a reMarkable 1 or 2, and install the required framebuffer dependencies.
+
+Do you support reMarkable Paper Pro or Move?
+--------------------------------------------
+
+Not at this time.
 
 Why doesn't toltec support the latest OS version as soon as it comes out?
-    Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.
+-------------------------------------------------------------------------
+
+Some of our packages require new versions to properly support a new OS release. For the reMarkable 2, the `display` needs to be updated so that any application that uses the screen will work. Without this being updated, you'll end up soft-bricking your device. Other packages like `ddvk-hacks` will just fail to install without having explicit support. Since this project is volunteer run, and we put things through a testing period before it can make it to stable, it can take a little while for us to catch up when new versions of the OS are being released.
 
 Can I add `__________` to Toltec?
-    We’re always open to adding new packages to the repository.
-    You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.
+---------------------------------
+
+We’re always open to adding new packages to the repository.
+You’ll find information about how to add a package in our `contributing guide <https://github.com/toltec-dev/toltec/blob/stable/docs/contributing.md>`_.
 
 I found a vulnerability in Toltec or one of its packages, where can I report it?
-    To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.
+-------------------------------------------------------------------------------------
+
+To inform the Toltec maintainers about a security issue, please follow the `security instructions <https://github.com/toltec-dev/organization/blob/main/docs/security.md>`_.
 
 Can I factory reset my reMarkable if I have toltec installed?
-    No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``.
+-------------------------------------------------------------
+
+No, **DO NOT** factory reset your reMarkable if you have toltec installed. First uninstall toltec with ``toltecctl uninstall``. For more information please reference `the factory reset guide article on remarkable.guide <https://remarkable.guide/tech/factory-reset.html>`_.
 
 Why can't I install toltec before my OS is supported?
-    `Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
+-----------------------------------------------------
+
+`Can I install toltec before my OS version is supported? <https://remarkable.guide/faqs.html#can-i-install-toltec-before-my-os-version-is-supported>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
 
 Why doesn’t toltec support the beta OS versions?
-    `Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
+------------------------------------------------
+
+`Why doesn’t toltec support the beta OS versions? <https://remarkable.guide/faqs.html#why-doesn-t-toltec-support-the-beta-os-versions>`_ on `remarkable.guide <https://remarkable.guide>`_ has a good write-up on why.
 
 My reMarkable seems to have become unresponsive, how do I fix it?
-   If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:
+-----------------------------------------------------------------
 
-   * reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
-   * reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.
-
-   If you can SSH in through USB, the following may work:
+If you can't SSH in through USB (using IP ``10.11.99.1``), there are tools that can help you recover your reMarkable if it becomes unresponsive:
 
-   .. parsed-literal::
+* reMarkable 1: `uuuflash <https://github.com/ddvk/remarkable-uuuflash>`_
+* reMarkable 2: `remarkable2-recovery <https://github.com/ddvk/remarkable2-recovery>`_.
+
+If you can SSH in through USB, the following may work:
+
+.. parsed-literal::
 
-      rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
-      systemctl unmask sync.service || systemctl unmask rm-sync.service
-      systemctl disable --now manual-sync.service
-      systemctl daemon-reload
-      systemctl reset-failed xochitl
-      systemctl restart xochitl
+  rm /etc/systemd/system/xochitl.service.d/toltec-wrapper.conf
+  systemctl unmask sync.service || systemctl unmask rm-sync.service
+  systemctl disable --now manual-sync.service
+  systemctl daemon-reload
+  systemctl reset-failed xochitl
+  systemctl restart xochitl