PYTHON-3738 Use tox for sphinx doc instead of setup.py (#1245)

mongodb · Jun 20, 2023 · bc66d83 · bc66d83
1 parent 82d87dc
commit bc66d83
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 5 deletions.
diff --git a/.github/workflows/test-python.yml b/.github/workflows/test-python.yml
@@ -83,9 +83,7 @@ jobs:
           cache-dependency-path: 'setup.py'
       - name: Install dependencies
         run: |
-          python -m pip install -U pip
-          python -m pip install sphinx
+          pip install tox
       - name: Check links
         run: |
-          cd doc
-          make linkcheck
+          tox -e linkcheck
diff --git a/tox.ini b/tox.ini
@@ -8,8 +8,20 @@ envlist =
     lint,
     # Run pre-commit on all files, including stages that require manual fixes.
     lint-manual,
+    # Typecheck using mypy.
+    typecheck-mypy,
+    # Typecheck using pyright.
+    typecheck-pyright,
+    # Typecheck using pyright strict.
+    typecheck-pyright-strict,
     # Typecheck all files.
-    typecheck
+    typecheck,
+    # Build sphinx docs
+    doc,
+    # Test sphinx docs
+    doc-test,
+    # Linkcheck sphinx docs
+    linkcheck
 
 [testenv:test]
 description = run unit tests
@@ -75,3 +87,24 @@ commands =
     {[testenv:typecheck-mypy]commands}
     {[testenv:typecheck-pyright]commands}
     {[testenv:typecheck-pyright-strict]commands}
+
+[testenv:doc]
+description = build sphinx docs
+deps =
+    sphinx
+commands =
+    sphinx-build -E -b html doc ./doc/_build/html
+
+[testenv:doc-test]
+description = run sphinx doc tests
+deps =
+    {[testenv:doc]deps}
+commands =
+    sphinx-build -E -b doctest doc ./doc/_build/doctest
+
+[testenv:linkcheck]
+description = check links of sphinx docs
+deps =
+    {[testenv:doc]deps}
+commands =
+    sphinx-build -E -b linkcheck doc ./doc/_build/linkcheck