docs: refactor to pyproject.toml, uv and subdirectory for markdown files

.github/workflows/cd-docs.yaml

@@ -15,27 +15,20 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Setup python
-        uses: actions/setup-python@v4
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v4
         with:
-          python-version: "3.10"
-
-      - uses: actions/cache@v4
-        id: pip-cache
-        with:
-          path: ${{ env.pythonLocation }}
-          key: ${{ runner.os }}-pip-${{ hashFiles('docs/_kalico/mkdocs-requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-
-      - name: Install dependencies
-        if: steps.pip-cache.outputs.cache-hit != 'true'
-        run: pip install -r docs/_kalico/mkdocs-requirements.txt
+          version: 'latest'
+          enable-cache: true
+          cache-dependency-glob: "docs/uv.lock"
+
+      - name: Setup Python
+        working-directory: docs/
+        run: uv python install
 
       - name: Build MkDocs Pages
-        run: |
-          cd docs/
-          mkdocs build -f _kalico/mkdocs.yml
+        working-directory: docs/ 
+        run: uv run mkdocs build
 
       - name: Deploy
         uses: JamesIves/[email protected]

.github/workflows/ci-docs_test.yaml

@@ -11,24 +11,17 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Setup python
-        uses: actions/setup-python@v4
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v4
         with:
-          python-version: "3.10"
-
-      - uses: actions/cache@v4
-        id: pip-cache
-        with:
-          path: ${{ env.pythonLocation }}
-          key: ${{ runner.os }}-pip-${{ hashFiles('docs/_kalico/mkdocs-requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-
-      - name: Install dependencies
-        if: steps.pip-cache.outputs.cache-hit != 'true'
-        run: pip install -r docs/_kalico/mkdocs-requirements.txt
+          version: 'latest'
+          enable-cache: true
+          cache-dependency-glob: "docs/uv.lock"
+
+      - name: Setup Python
+        working-directory: docs/
+        run: uv python install
 
       - name: Build MkDocs Pages
-        run: |
-          cd docs/
-          mkdocs build -f _kalico/mkdocs.yml --strict
+        working-directory: docs/
+        run: uv run mkdocs build --strict

README.md

@@ -1,4 +1,4 @@
-<p align="center"><a href="https://docs.kalico.gg"><img align="center" src="docs/logo/kalico-big.png" alt="Kalico Logo"></a></p>
+<p align="center"><a href="https://docs.kalico.gg"><img align="center" src="docs/src/logo/kalico-big.png" alt="Kalico Logo"></a></p>
 
 [![Action Status](https://github.com/KalicoCrew/kalico/actions/workflows/ci-build_test.yaml/badge.svg?branch=main)](https://github.com/KalicoCrew/kalico/actions/workflows/ci-build_test.yaml)
 
@@ -128,8 +128,8 @@ See the [Danger Features document](https://docs.kalico.gg/Danger_Features.html)
 
 - [danger_options: configurable homing constants](https://github.com/KalicoCrew/kalico/pull/378)
 
-If you're feeling adventurous, take a peek at the extra features in the bleeding-edge-v2 branch [feature documentation](docs/Bleeding_Edge.md)
-and [feature configuration reference](docs/Config_Reference_Bleeding_Edge.md):
+If you're feeling adventurous, take a peek at the extra features in the bleeding-edge-v2 branch [feature documentation](docs/src/Bleeding_Edge.md)
+and [feature configuration reference](docs/src/Config_Reference_Bleeding_Edge.md):
 
 - [extruder/pa: do not smooth base extruder position, only advance](https://github.com/KalicoCrew/kalico/pull/266)
 

config/example-cartesian.cfg

@@ -5,7 +5,7 @@
 # DO NOT COPY THIS FILE WITHOUT CAREFULLY READING AND UPDATING IT
 # FIRST. Incorrectly configured parameters may cause damage.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PF0

config/example-corexy.cfg

@@ -5,7 +5,7 @@
 # DO NOT COPY THIS FILE WITHOUT CAREFULLY READING AND UPDATING IT
 # FIRST. Incorrectly configured parameters may cause damage.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PF0

config/example-corexz.cfg

@@ -4,7 +4,7 @@
 # DO NOT COPY THIS FILE WITHOUT CAREFULLY READING AND UPDATING IT
 # FIRST. Incorrectly configured parameters may cause damage.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PF0

config/example-delta.cfg

@@ -4,7 +4,7 @@
 # DO NOT COPY THIS FILE WITHOUT CAREFULLY READING AND UPDATING IT
 # FIRST. Incorrectly configured parameters may cause damage.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_a]
 step_pin: PF0

config/example-deltesian.cfg

@@ -5,7 +5,7 @@
 # DO NOT COPY THIS FILE WITHOUT CAREFULLY READING AND UPDATING IT
 # FIRST. Incorrectly configured parameters may cause damage.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_left]
 step_pin: PF0

config/example-extras.cfg

@@ -1,4 +1,4 @@
-# Documentation on config parameters has moved to: docs/Config_Reference.md
+# Documentation on config parameters has moved to: docs/src/Config_Reference.md
 
 # The latest version of the config reference is also available online at:
 #   https://www.klipper3d.org/Config_Reference.html

config/example-hybrid-corexy.cfg

@@ -5,7 +5,7 @@
 # DO NOT COPY THIS FILE WITHOUT CAREFULLY READING AND UPDATING IT
 # FIRST. Incorrectly configured parameters may cause damage.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PF0

config/example-hybrid-corexz.cfg

@@ -5,7 +5,7 @@
 # DO NOT COPY THIS FILE WITHOUT CAREFULLY READING AND UPDATING IT
 # FIRST. Incorrectly configured parameters may cause damage.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PF0

config/example-polar.cfg

@@ -4,7 +4,7 @@
 # POLAR KINEMATICS ARE A WORK IN PROGRESS. Moves around the 0, 0
 # position are known to not work properly.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_bed]
 step_pin: PF0

config/example-rotary-delta.cfg

@@ -4,7 +4,7 @@
 # ROTARY DELTA KINEMATICS ARE A WORK IN PROGRESS. Homing moves may
 # timeout and some boundary checks are not implemented.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_a]
 step_pin: PF0

config/example-winch.cfg

@@ -8,7 +8,7 @@
 # home the printer, manually send movement commands until the toolhead
 # is at 0, 0, 0 and then issue a G28 command.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_a]
 step_pin: PF0

config/example.cfg

@@ -1,4 +1,4 @@
-# Documentation on config parameters has moved to: docs/Config_Reference.md
+# Documentation on config parameters has moved to: docs/src/Config_Reference.md
 
 # The latest version of the config reference is also available online at:
 #   https://www.klipper3d.org/Config_Reference.html

config/generic-I3DBEEZ9.cfg

@@ -7,7 +7,7 @@
 # file named "firmware.bin" on an SD card and then restart the I3DBEEZ9
 # with that SD card.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PE9

config/generic-alligator-r2.cfg

@@ -8,7 +8,7 @@
 # See alligator github for alligator manager:
 # https://github.com/3Dartists/alligator-manager
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [static_digital_output DRV8825_microstepping]
 pins:PC10

config/generic-alligator-r3.cfg

@@ -8,7 +8,7 @@
 # See alligator github for alligator manager:
 # https://github.com/3Dartists/alligator-manager
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [static_digital_output DRV8825_microstepping]
 pins:PC10

config/generic-archim2.cfg

@@ -2,7 +2,7 @@
 # boards. To use this config, the firmware should be compiled for the
 # SAM3x8e.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PC6

config/generic-azteeg-x5-mini-v3.cfg

@@ -1,7 +1,7 @@
 # This file contains common pin mappings for the Azteeg X5 Mini v3. To use
 # this config, the firmware should be compiled for the LPC1769.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: P2.1

config/generic-bigtreetech-e3-rrf-v1.1.cfg

@@ -7,7 +7,7 @@
 # file named "firmware.bin" on an SD card and then restart the E3 RRF
 # 1.1 with that SD card.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PD5

config/generic-bigtreetech-gtr.cfg

@@ -7,7 +7,7 @@
 # file named "firmware.bin" on an SD card and then restart the GTR
 # with that SD card.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PC15

config/generic-bigtreetech-manta-e3ez.cfg

@@ -3,7 +3,7 @@
 # STM32G0B1 with a "8KiB bootloader" "8 MHz crystal"
 # and "USB (on PA11/PA12)" or "CAN bus (on PB12/PB13)".
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PA14

config/generic-bigtreetech-manta-m4p.cfg

@@ -2,7 +2,7 @@
 # To use this config, the firmware should be compiled for the
 # STM32G0B1 with a "8KiB bootloader" and USB communication.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PC6

config/generic-bigtreetech-manta-m5p.cfg

@@ -3,7 +3,7 @@
 # STM32G0B1 with a "8KiB bootloader" "8 MHz crystal"
 # and "USB (on PA11/PA12)" or "CAN bus (on PD0/PD1)".
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PC8

config/generic-bigtreetech-manta-m8p-v1.0.cfg

@@ -2,7 +2,7 @@
 # To use this config, the firmware should be compiled for the
 # STM32G0B1 with a "8KiB bootloader" and USB communication.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PE2

config/generic-bigtreetech-manta-m8p-v1.1.cfg

@@ -3,7 +3,7 @@
 # STM32G0B1 with a "8KiB bootloader" "8 MHz crystal"
 # and "USB (on PA11/PA12)" or "CAN bus (on PD12/PD13)".
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PE2

config/generic-bigtreetech-octopus-max-ez.cfg

@@ -3,7 +3,7 @@
 # STM32H723 with a "128KiB bootloader" "25 MHz crystal"
 # and "USB (on PA11/PA12)" or "CAN bus (on PD0/PD1)".
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 # Motor-1
 [stepper_x]

config/generic-bigtreetech-octopus-pro-v1.0.cfg

@@ -13,7 +13,7 @@
 # bootloader" and an "8MHz crystal". For STM32H723 boards use a
 # "128KiB bootloader" and a "25Mhz crystal".
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 # Driver0
 [stepper_x]

config/generic-bigtreetech-octopus-pro-v1.1.cfg

@@ -9,7 +9,7 @@
 # micro-controller, select a "128KiB bootloader", and select a "25Mhz
 # crystal".
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 # Driver0
 [stepper_x]

config/generic-bigtreetech-octopus-v1.1.cfg

@@ -12,7 +12,7 @@
 # clock reference. For STM32F429 boards use a "32KiB bootloader" and
 # an "8MHz crystal".
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 # Driver0
 [stepper_x]

config/generic-bigtreetech-skr-2.cfg

@@ -11,7 +11,7 @@
 # file named "firmware.bin" on an SD card and then restart the SKR 2
 # with that SD card.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 # Note: The initial revision of this board has a flaw that can cause
 # damage to itself and other boards. Be sure to verify the board is

config/generic-bigtreetech-skr-3.cfg

@@ -4,7 +4,7 @@
 # options", "STM32H743" or "STM32H723", "128KiB bootloader",
 # and "25MHz clock".
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PD4

config/generic-bigtreetech-skr-cr6-v1.0.cfg

@@ -9,7 +9,7 @@
 # file named "firmware.bin" on an SD card and then restart the SKR
 # CR6 V1.0 with that SD card.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: PB13

config/generic-bigtreetech-skr-e3-dip.cfg

@@ -9,7 +9,7 @@
 # file named "firmware.bin" on an SD card and then restart the SKR E3
 # DIP with that SD card.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 # Note: This board has a design flaw in its thermistor circuits that
 # cause inaccurate temperatures (most noticeable at low temperatures).

config/generic-bigtreetech-skr-e3-turbo.cfg

@@ -2,7 +2,7 @@
 # Turbo. To use this config, the firmware should be compiled for the
 # LPC1769.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 [stepper_x]
 step_pin: P1.4

config/generic-bigtreetech-skr-mini-e3-v1.0.cfg

@@ -9,7 +9,7 @@
 # file named "firmware.bin" on an SD card and then restart the SKR
 # mini E3 with that SD card.
 
-# See docs/Config_Reference.md for a description of parameters.
+# See docs/src/Config_Reference.md for a description of parameters.
 
 # Note: This board has a design flaw in its thermistor circuits that
 # cause inaccurate temperatures (most noticeable at low temperatures).