Modernize package management with uv

Author: octylFractal

.python-version

@@ -0,0 +1 @@
+3.14

.readthedocs.yaml

@@ -1,35 +1,28 @@
 # Read the Docs configuration file for Sphinx projects
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
 version: 2
 
 # Set the OS, Python version and other tools you might need
 build:
   os: ubuntu-24.04
   tools:
     python: "3.14"
-    # You can also specify other tool versions:
-    # nodejs: "20"
-    # rust: "1.70"
-    # golang: "1.20"
+  pre_create_environment:
+    - asdf plugin add uv
+    - asdf install uv latest
+    - asdf global uv latest
+  create_environment:
+    - uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
+  install:
+    - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --group docs
 
 # Build documentation in the "source/" directory with Sphinx
 sphinx:
   configuration: source/conf.py
-  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
   builder: "dirhtml"
-  # Fail on all warnings to avoid broken references
-  # fail_on_warning: true
+  fail_on_warning: true
 
 # Optionally build your docs in additional formats such as PDF and ePub
 formats:
   - pdf
   - epub
-
-# Optional but recommended, declare the Python requirements required
-# to build your documentation
-# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-python:
-  install:
-    - requirements: source/requirements.txt

README.md

@@ -5,10 +5,12 @@ These are the files for WorldEdit's documentation.
 Contributions are welcome. Please read the licensing information below.
 
 # Dev Setup
-```bash
-pip install -r requirements.txt
-# Now you can run ./dev.py to auto-rebuild the docs into build/dirhtml, and browse it at the printed address.
-```
+[Install `uv`](https://docs.astral.sh/uv/getting-started/installation/).
+
+Most IDEs should support `uv` out of the box, but you can run `uv sync` if you need a virtual environment with the 
+dependencies installed.
+
+Use `uv run dev.py` to auto-rebuild docs into `build/dirhtml`, then browse it at the printed address.
 
 # License
 

pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "WorldEditDocs"
+version = "0.0.1"
+description = "WorldEdit documentation"
+readme = "README.md"
+requires-python = ">=3.14"
+classifiers = [
+    "Private :: Do Not Upload",
+]
+
+[tool.uv.extra-build-dependencies]
+# Can be removed with https://github.com/EngineHub/sphinxcontrib.youtube/pull/1
+enginehub-sphinx-youtube = ["setuptools==80.10.2"]
+
+[dependency-groups]
+# Dependencies for `dev.py`.
+dev = [
+    { include-group = "docs" },
+    "watchdog>=6.0.0",
+]
+# Dependencies for building the documentation.
+docs = [
+    "enginehub-sphinx-youtube>=0.2.3",
+    "shibuya>=2026.1.9",
+    "sphinx>=9.1.0",
+]

requirements.txt

@@ -47,7 +47,7 @@ Once you've set up your Bukkit-based server (instructions can be found on the re
 Check your server log for errors. If you encounter errors, see the :doc:`FAQ <faq>` page.
 
 NeoForge Single-Player
-~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~
 
 First, you'll have to install NeoForge. There are many third-party launchers designed to easily install modpacks. If you're using one of those, you can add WorldEdit as a mod through the launcher interface. Otherwise, NeoForge will install a profile available through the official Minecraft Launcher. After installing NeoForge one way or the other, `download WorldEdit from Modrinth <https://modrinth.com/plugin/worldedit/versions?l=neoforge>`_. Make sure you get the right WorldEdit download for your Minecraft version and platform.
 
@@ -69,7 +69,7 @@ On Minecraft 1.14.x versions, you will also need to install the `Fabric API mod
 Add the WorldEdit .jar to the "loader mods" section of your MultiMC instance and check to enable it, or add the jar to your mods folder (see NeoForge instructions above) if you're installing in the official Mojang launcher.
 
 NeoForge Server / Sponge
-~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 First, you'll have to install your server software of choice. For NeoForge, you can download the installer and run ``java -jar neoforge-installer.jar --installServer`` from a terminal or command prompt (search online for more comprehensive instructions). Sponge has `documentation on setting up a server <https://docs.spongepowered.org/stable/en/server/quickstart.html>`_. After installing your server software, download WorldEdit from `Modrinth, if using NeoForge <https://modrinth.com/plugin/worldedit/versions?l=neoforge>`_ or `Ore, if using Sponge <https://ore.spongepowered.org/EngineHub/WorldEdit>`_.