From 07bd8626cc6f0fe15163ada08fbdd0751e3747d1 Mon Sep 17 00:00:00 2001 From: Nathaniel van Diepen Date: Tue, 6 Jan 2026 18:07:47 -0700 Subject: [PATCH 1/2] Add anchors to faqs, update python, use static sidebar due to limitations in sphinx sidebars --- .github/workflows/publish.yml | 48 +++++------ requirements.txt | 30 +------ .../__pycache__/bootstrap.cpython-313.pyc | Bin 0 -> 2485 bytes src/_themes/toltec/nav.html | 24 +++++- src/conf.py | 2 +- src/index.rst | 75 ++++++++++++------ 6 files changed, 102 insertions(+), 77 deletions(-) create mode 100644 src/_ext/__pycache__/bootstrap.cpython-313.pyc diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 1f85bdd..be64164 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -1,27 +1,27 @@ name: publish on: - push: - branches: - - main - repository_dispatch: + push: + branches: + - main + 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 + 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 diff --git a/requirements.txt b/requirements.txt index 5909382..d3cbcc5 100644 --- a/requirements.txt +++ b/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 diff --git a/src/_ext/__pycache__/bootstrap.cpython-313.pyc b/src/_ext/__pycache__/bootstrap.cpython-313.pyc new file mode 100644 index 0000000000000000000000000000000000000000..186e8ba0220bb9a67759b821cdcd97e1110d4fe6 GIT binary patch literal 2485 zcmah~O>7fK6rT0k>-E~sPZJA^48o|5Q8SL+CfwaX-EccBcT`K}keVl1q9 ziMJ?y#0SzlA`JV9Uq+Yxi8|M9Rd%Awfqt&kCsNYaf=DpSM+Bu7l+rnK#?VbABilJF z>xzx3EvHS>rZ!P5nW{vyY+0eQr4U;-CyQq3f~IF=iA8cc2fr${9lSfbXE;ANMCi z<3bHehTr9nfz6xdcf(i~9Y9A>#Rt^&Bveobc#_fR_aE>bXp(!2#p?fBm?euy&8QQo zT(B{?OCp}tsGTyWuYHoUZHu0c#fUN!&1!b8kSoveATnk_jPoa#Y-6V zI}(8m12Y3{Ip|t@G%8=OB%w%h*BP%eHa&e>b~q{0NO(5SJ7sEyBfv(0QXP*;9Wk#= zW9U#vD4rY00?~CX?f41)tN`zX;|GOlVZ-qjTY=^Zwx&Bl)wJd&H65GjDMw%giizXZ zj7ih+GoEEWz*afgKLBbQ28Du^fv3j_ddBrJ=Lub5{N1I)^RcEBk@YIj0) zix+QQTvG2&-JV+R-3UeJ<2zpA#>f{VOZ;8wwzNF9?mhA>Si3lQYjCNs6>M7zw*6YK zEeOxT4U1Q9UfBwFt%bXm&u@l%SLnCrzT5MIce5}4bHh&Povl#&dZ_&#T|T=R>Uqhd z{`1^cxc3hM1!@&c#hh4^-;X)DyR7V22`JqaCt!K1zJfk&zJxrplaZ`B@Jt39+)+dY3_yT0*m%k7qX zm)7bdTlKM(#QgAfM`T;-S!r649&|nu`(N;!JTQOu#_;FE3)k1Z`(L)Pz#jL-UqNt> z!@aLw)`8#0ftFYFI3()Fp>X^N|1j7TZ}vUx5&{1diNpu_)n+N)9a!!1gJ$)J6hGx( z9hA-o{E?93Po*-Zno1G&8Wf9;9AK!8HOZf)h_Lt431qQ-sZ>8=DrG2n z4D&nK1a@NIlxn_olH!@XnJMUah%g#umyt5?oaZ?1g-77Lf7T$b@hPf#iULnj82-PY dj^_fB>bC+d>yX(~8-auK!mhB78z^3-zX9XMIGO+e literal 0 HcmV?d00001 diff --git a/src/_themes/toltec/nav.html b/src/_themes/toltec/nav.html index 64ac6fb..32de7e2 100644 --- a/src/_themes/toltec/nav.html +++ b/src/_themes/toltec/nav.html @@ -1,3 +1,25 @@ diff --git a/src/conf.py b/src/conf.py index 4233f49..fbdfb7c 100644 --- a/src/conf.py +++ b/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 = [ diff --git a/src/index.rst b/src/index.rst index 7b71a9a..120fb59 100644 --- a/src/index.rst +++ b/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 `_ or `join the reMarkable community on Discord `_. - Please do not open issues to ask for help, as they're used exclusively for `package requests `_ and `bug reports `_. +--------------------- + +If you need help with Toltec or one of its packages, you can `start a discussion on GitHub `_ or `join the reMarkable community on Discord `_. +Please do not open issues to ask for help, as they're used exclusively for `package requests `_ and `bug reports `_. 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 `_. +------------------------------ + +Probably not, but `standard disclaimers apply `_. 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 `_. +--------------------------------- + +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 `_. 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 `_. +------------------------------------------------------------------------------------- + +To inform the Toltec maintainers about a security issue, please follow the `security instructions `_. 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 `_. Why can't I install toltec before my OS is supported? - `Can I install toltec before my OS version is supported? `_ on `remarkable.guide `_ has a good write-up on why. +----------------------------------------------------- + +`Can I install toltec before my OS version is supported? `_ on `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? `_ on `remarkable.guide `_ has a good write-up on why. +------------------------------------------------ + +`Why doesn’t toltec support the beta OS versions? `_ on `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 `_ - * reMarkable 2: `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 `_ +* reMarkable 2: `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 From 3d1f9bbc31cf714fba68da4fd287a296f7e8409c Mon Sep 17 00:00:00 2001 From: Nathaniel van Diepen Date: Tue, 6 Jan 2026 18:19:29 -0700 Subject: [PATCH 2/2] Build on PR but don't sync --- .github/workflows/publish.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index be64164..29e4d07 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -3,6 +3,9 @@ on: push: branches: - main + pull_request: + branches: + - "*" repository_dispatch: jobs: publish: @@ -18,6 +21,7 @@ jobs: - 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/