Move docs requirements to pyproject.toml

hermanzdosilovic · hermanzdosilovic · commit 57050fab0b53 · 2025-01-05T22:31:46.000+01:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -17,10 +17,10 @@ jobs:
         persist-credentials: false
         fetch-depth: 0       # Fetch the full history
         ref: ${{ github.ref }} # Check out the current branch or tag
-  
+
     - name: Fetch tags only
       run: git fetch --tags --no-recurse-submodules
-    
+
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
@@ -29,7 +29,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r docs/requirements.txt
+        pip install -e [docs]
 
     - name: Build documentation
       run: sphinx-multiversion docs/source docs/build/html --keep-going --no-color
@@ -41,7 +41,7 @@ jobs:
         # Get the latest tag
         latest_tag=$(git tag --sort=-creatordate | head -n 1)
         echo "LATEST_RELEASE=$latest_tag" >> $GITHUB_ENV
-    
+
     - name: Generate index.html for judge0.github.io/judge0-python.
       run: |
         echo '<!DOCTYPE html>
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/source/contributors_guide/contributing.rst b/docs/source/contributors_guide/contributing.rst
@@ -24,8 +24,7 @@ Preparing the development setup
 
 .. code-block:: console
 
-    $ pip install -e .[test]
-    $ pip install -r docs/requirements.txt # needed for building the docs
+    $ pip install -e [dev]
     $ pre-commit install
 
 Building documentation
@@ -73,7 +72,7 @@ without changing the tests.
 You can use the fixtures in your tests like this:
 
 .. code-block:: python
-    
+
     def test_my_test(request):
         client = request.getfixturevalue("ce_client") # or extra_ce_client
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -45,7 +45,16 @@ test = [
     "pytest-cov==6.0.0",
     "flake8-docstrings==1.7.0",
 ]
-docs = ["sphinx==7.4.7"]
+docs = [
+    "sphinx==7.4.7",
+    "sphinxawesome-theme==5.3.2",
+    "sphinx-autodoc-typehints==2.3.0",
+    "sphinx-multiversion==0.2.4",
+]
+dev = [
+    "judge0[test]",
+    "judge0[docs]",
+]
 
 [tool.flake8]
 extend-ignore = [
