Modernize docs and tooling

- Switch to Furo theme (https://github.com/pradyunsg/furo)
- Add MyST Markdown support and extensions (https://mystmd.org/)
- Replace `pip` with `uv`

Author: jeromegamez

.readthedocs.yaml

@@ -3,13 +3,21 @@
 version: 2
 
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.11"
+    python: "3.12"
+  jobs:
+    pre_create_environment:
+      - asdf plugin add uv
+      - asdf install uv latest
+      - asdf global uv latest
+
+    install:
+      - cd docs && uv sync
+
+    build:
+      html:
+        - cd docs && uv run sphinx-build -T -b html . $READTHEDOCS_OUTPUT/html
 
 sphinx:
   configuration: docs/conf.py
-
-python:
-  install:
-    - requirements: docs/requirements.txt

composer.json

@@ -91,7 +91,24 @@
             "vendor/bin/php-cs-fixer fix --diff --verbose"
         ],
         "docs": [
-            "cd docs && uv run make html"
+            "@docs:clean",
+            "@docs:setup",
+            "@docs:build"
+        ],
+        "docs:build": [
+            "cd docs && uv run sphinx-build -b html . _build/html"
+        ],
+        "docs:clean": [
+            "cd docs && rm -rf _build/*"
+        ],
+        "docs:linkcheck": [
+            "cd docs && uv run sphinx-build -b linkcheck . _build/linkcheck"
+        ],
+        "docs:serve": [
+            "cd docs && uv run sphinx-autobuild . _build/html --host 0.0.0.0 --port 8000"
+        ],
+        "docs:setup": [
+            "cd docs && uv sync"
         ],
         "pre-push": [
             "@rector-fix",
@@ -117,21 +134,21 @@
         "test-bc": [
             "docker run -it --rm -v `pwd`:/app nyholm/roave-bc-check"
         ],
-        "test-dependencies": [
-            "vendor/bin/composer-dependency-analyser"
-        ],
         "test-coverage": [
             "Composer\\Config::disableProcessTimeout",
             "XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html=.build/coverage"
         ],
+        "test-dependencies": [
+            "vendor/bin/composer-dependency-analyser"
+        ],
         "test-emulator": [
             "FIREBASE_AUTH_EMULATOR_HOST=localhost:9099 FIREBASE_DATABASE_EMULATOR_HOST=localhost:9100 firebase emulators:exec --only auth,database --project beste-firebase 'vendor/bin/phpunit --group=emulator'"
         ],
-        "test-units": [
-            "vendor/bin/phpunit --testsuite=unit"
-        ],
         "test-integration": [
             "vendor/bin/phpunit --testsuite=integration"
+        ],
+        "test-units": [
+            "vendor/bin/phpunit --testsuite=unit"
         ]
     },
     "extra": {

docs/.python-version

@@ -0,0 +1 @@
+3.12

docs/Makefile

@@ -14,31 +14,37 @@ Before you start, please read about Firebase App Check in the official documenta
 Initializing the App Check component
 ************************************
 
-**With the SDK**
+.. tab-set::
 
-.. code-block:: php
+   .. tab-item:: SDK
 
-    $appCheck = $factory->createAppCheck();
+      .. code-block:: php
 
-**With Dependency Injection** (`Symfony Bundle <https://github.com/kreait/firebase-bundle>`_/`Laravel/Lumen Package <https://github.com/kreait/laravel-firebase>`_)
+         $appCheck = $factory->createAppCheck();
 
-.. code-block:: php
+   .. tab-item:: Symfony
 
-    use Kreait\Firebase\Contract\AppCheck;
+      See the `Symfony Bundle documentation <https://github.com/kreait/firebase-bundle>`_ for configuration details.
 
-    class MyService
-    {
-        public function __construct(AppCheck $appCheck)
-        {
-            $this->appCheck = $appCheck;
-        }
-    }
+      .. code-block:: php
 
-**With the Laravel** ``app()`` **helper** (`Laravel/Lumen Package <https://github.com/kreait/laravel-firebase>`_)
+         use Kreait\Firebase\Contract\AppCheck;
 
-.. code-block:: php
+         class MyService
+         {
+             public function __construct(AppCheck $appCheck)
+             {
+                 $this->appCheck = $appCheck;
+             }
+         }
+
+   .. tab-item:: Laravel
+
+      See the `Laravel Package documentation <https://github.com/kreait/laravel-firebase>`_ for configuration details.
+
+      .. code-block:: php
 
-    $appCheck = app('firebase.app_check');
+         $appCheck = app('firebase.app_check');
 
 
 .. _verify-app-check-tokens: