chore: migrate hardware manual to Markdown (part 2)

.github/workflows/build.yml

@@ -27,6 +27,10 @@ jobs:
         python-version: '3.10'
     - name: Install Python dependencies
       run: pip install --upgrade -r requirements.txt
+    - name: Patch linuxdoc
+      run: >
+        python -c "import linuxdoc; print(linuxdoc.__path__[0])"
+        | xargs -I{} patch -d {} -p1 -N -i patches/linuxdoc-rstFlatTable.patch || true
     - name: Build versioned HTML manual
       run: sh build_html.sh
     - name: Deploy to Netlify
@@ -63,6 +67,10 @@ jobs:
         python-version: '3.10'
     - name: Install Python dependencies
       run: pip install --upgrade -r requirements.txt
+    - name: Patch linuxdoc
+      run: >
+        python -c "import linuxdoc; print(linuxdoc.__path__[0])"
+        | xargs -I{} patch -d {} -p1 -N -i patches/linuxdoc-rstFlatTable.patch || true
     - name: Set up SSH Agent
       if: (github.event_name == 'push' || github.event_name == 'repository_dispatch') && env.SSH_PRIVATE_KEY != null
       env:

.github/workflows/mixxx-controls-ts.yml

@@ -32,6 +32,7 @@ jobs:
         working-directory: manual
         run: |
           pip install -r requirements.txt
+          python -c "import linuxdoc; print(linuxdoc.__path__[0])" | xargs -I{} patch -d {} -p1 -N -i patches/linuxdoc-rstFlatTable.patch || true
           pip install pre-commit
           make html
 

.github/workflows/sphinx.yml

@@ -19,6 +19,10 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         python -m pip install -r requirements.txt
+    - name: Patch linuxdoc
+      run: >
+        python -c "import linuxdoc; print(linuxdoc.__path__[0])"
+        | xargs -I{} patch -d {} -p1 -N -i patches/linuxdoc-rstFlatTable.patch || true
     - name: Check for broken links
       run: sphinx-build -q --color -b linkcheck source build
 
@@ -38,6 +42,10 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         python -m pip install -r requirements.txt
+    - name: Patch linuxdoc
+      run: >
+        python -c "import linuxdoc; print(linuxdoc.__path__[0])"
+        | xargs -I{} patch -d {} -p1 -N -i patches/linuxdoc-rstFlatTable.patch || true
     - name: Load problem matcher
       uses: ammaraskar/sphinx-problem-matcher@master
     - name: Check for build issues

.pre-commit-config.yaml

@@ -54,7 +54,7 @@ repos:
   - id: rstcheck
     name: "Check RST syntax"
     args: [
-      --ignore-messages=(Hyperlink target.*not referenced)\.$,
+      --ignore-messages=(Hyperlink target.*not referenced|File referenced in "include" directive not found:.*)\.$,
     ]
     additional_dependencies:
     - sphinx

Makefile

@@ -116,10 +116,10 @@ latex:
 	      "(use \`make latexpdf' here to do that automatically)."
 
 latexpdf:
-	$(SPHINXBUILD) source $(BUILDDIR)/latex -b latex $(ALLSPHINXOPTS)
-	@echo "Running LaTeX files through pdflatex..."
-	$(MAKE) -C $(BUILDDIR)/latex all-pdf
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+	$(SPHINXBUILD) source $(BUILDDIR)/latex -b latex $(ALLSPHINXOPTS) -Dlatex_engine=xelatex
+	@echo "Running LaTeX files through xelatex..."
+	$(MAKE) -C $(BUILDDIR)/latex LATEXMKOPTS="-f -interaction=nonstopmode -pdf -xelatex" all-pdf
+	@echo "xelatex finished; the PDF files are in $(BUILDDIR)/latex."
 
 latexpdfja:
 	$(SPHINXBUILD) source $(BUILDDIR)/latex -b latex $(ALLSPHINXOPTS)

patches/linuxdoc-rstFlatTable.patch

@@ -0,0 +1,11 @@
+--- a/linuxdoc/rstFlatTable.py
++++ b/linuxdoc/rstFlatTable.py
+@@ -327,7 +327,7 @@ def parseCellItem(self, cellItem):
+         cspan = rspan = 0
+         if not len(cellItem):  # pylint: disable=len-as-condition
+             return cspan, rspan, []
+-        for elem in cellItem[0]:
++        for elem in list(cellItem.findall(lambda n: isinstance(n, (colSpan, rowSpan)))):
+             if isinstance(elem, colSpan):
+                 cspan = elem.get("span")
+                 elem.parent.remove(elem)

requirements.txt

@@ -9,4 +9,5 @@ transifex-client
 sphinxcontrib-svg2pdfconverter
 sphinx-rtd-theme
 sphinx-multiversion
+linuxdoc
 ./sphinx-mixxx

source/chapters/advanced_topics.rst

@@ -233,7 +233,7 @@ Effects via JACK Rack on GNU/Linux
    The Jack routing for external effects on GNU/Linux
 
 Use `Jack <https://en.wikipedia.org/wiki/JACK_Audio_Connection_Kit>`_ to route
-each deck directly through `JACK Rack <http://jack-rack.sourceforge.net/>`_
+each deck directly through `JACK Rack <https://jack-rack.sourceforge.net/>`_
 effect racks, or for more control you can use Ardour (or another :term:`DAW`)
 using sends for effects. This gives Mixxx access to the extensive collection of
 :term:`LADSPA` plugins.
@@ -288,7 +288,6 @@ Migrate your Mixxx library and settings to Flatpak
 Since version 2.5 Mixxx is also provided as Flatpak.
 
 If you do want to switch from a distribution package or Mixxx built from source code to the Flatpak, a little setup is required. Flatpak stores Mixxx's database, settings, and custom controller mappings in a different location than the `~/.mixxx` directory that Mixxx has always used before. Flatpak uses `~/.var/app/org.mixxx.Mixxx/.mixxx` instead. To copy your database, settings, and controller mappings into the Flatpak sandbox, run:
-::
 
   mkdir -p ~/.var/app/org.mixxx.Mixxx
   cp -r ~/.mixxx ~/.var/app/org.mixxx.Mixxx

source/chapters/appendix/additional_resources.rst

@@ -43,5 +43,5 @@ There are a variety of other resources where you can find out more:
 
 * **Social Media**: Follow us on `Mastodon <https://floss.social/@mixxx>`_,
   `Bluesky <https://bsky.app/profile/mixxx.bsky.social>`_,
-  `Facebook <https://www.facebook.com/pages/Mixxx-DJ-Software/21723485212>`_ and
+  `Facebook <https://www.facebook.com/mixxxdj/>`_ and
   `YouTube <https://www.youtube.com/@mixxxdj/posts>`_

source/chapters/preferences/sound_hardware.rst

@@ -109,7 +109,7 @@ is available. Soundcards designed for musicians almost always have an ASIO
 driver available, but audio interfaces built into computers and very cheap
 audio interfaces typically do not have an ASIO driver. If there is no ASIO
 driver available for your audio interface, use the WDM-KS API. There is
-generally no advantage to using `ASIO4ALL <http://www.asio4all.org>`_, a wrapper
+generally no advantage to using `ASIO4ALL <https://asio4all.org>`_, a wrapper
 around the WDM-KS API.
 
 GNU/Linux

source/conf.py

@@ -38,6 +38,7 @@
     "myst_parser",
     "sphinx_mixxx",
     "notfound.extension",
+    "linuxdoc.rstFlatTable",
 ]
 
 todo_include_todos = True
@@ -472,6 +473,9 @@
 # Avoid freezing during linkcheck
 linkcheck_timeout = 60
 linkcheck_retries = 2
+user_agent = (
+    "Mozilla/5.0 (X11; Linux x86_64; rv:152.0) Gecko/20100101 Firefox/152.0"
+)
 
 # Don't verify TLS
 tls_verify = False
@@ -480,4 +484,6 @@
 myst_enable_extensions = [
     "attrs_block",
     "colon_fence",
+    "deflist",
 ]
+per_section_footnotes = True

source/hardware/controllers/american_audio_radius_2000.md

@@ -4,7 +4,7 @@ A CD and USB media player that can control Mixxx over USB with MIDI. It
 can also play timecode from CDs or USB drives which can control Mixxx
 when they are connected by a sound card.
 
--  [Manufacturer’s product page](https://www.americandj.eu/en/radius-2000.html)
+-  [Manufacturer’s product page](https://www.adj.eu/radius-2000)
 
 :::{versionadded} 1.10
 :::