Build documentation via tox (#36)

To build the documentation, run `tox -e doc`. Build the documentation on GHA.
ICB-DCM · Jan 13, 2025 · c9460f2 · c9460f2
1 parent cb484eb
commit c9460f2
Show file tree

Hide file tree

Showing 14 changed files with 42 additions and 2 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -115,3 +115,31 @@ jobs:
         echo $! > ccompass_pid.txt
         sleep 10
         kill $(cat ccompass_pid.txt)
+
+  test_docs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+
+    - name: Cache tox
+      uses: actions/cache@v4
+      with:
+        path: ~/.cache/tox
+        key: ${{ runner.os }}-tox-${{ hashFiles('pyproject.toml') }}
+        restore-keys: |
+          ${{ runner.os }}-tox-
+
+    - name: Install dependencies
+      run: |
+        pip install tox
+
+    - name: Build documentation
+      run: |
+        tox -e doc
diff --git a/doc/.gitignore b/doc/.gitignore
@@ -0,0 +1 @@
+_build
diff --git a/docs/Makefile → doc/Makefile b/docs/Makefile → doc/Makefile
diff --git a/docs/changelog.rst → doc/changelog.rst b/docs/changelog.rst → doc/changelog.rst
diff --git a/docs/conf.py → doc/conf.py b/docs/conf.py → doc/conf.py
@@ -24,4 +24,4 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "alabaster"
-html_static_path = ["_static"]
+# html_static_path = ["_static"]
diff --git a/docs/contributing.rst → doc/contributing.rst b/docs/contributing.rst → doc/contributing.rst
diff --git a/docs/faq.rst → doc/faq.rst b/docs/faq.rst → doc/faq.rst
diff --git a/docs/index.rst → doc/index.rst b/docs/index.rst → doc/index.rst
diff --git a/docs/installation.rst → doc/installation.rst b/docs/installation.rst → doc/installation.rst
diff --git a/docs/license.rst → doc/license.rst b/docs/license.rst → doc/license.rst
diff --git a/docs/make.bat → doc/make.bat b/docs/make.bat → doc/make.bat
diff --git a/docs/preparation.rst → doc/preparation.rst b/docs/preparation.rst → doc/preparation.rst
diff --git a/docs/usage.rst → doc/usage.rst b/docs/usage.rst → doc/usage.rst
diff --git a/pyproject.toml b/pyproject.toml
@@ -27,4 +27,15 @@ requires-python = ">=3.10"
 ccompass = "ccompass.CCMPS:main"
 
 [project.optional-dependencies]
-dev = ["pre-commit>=3"]
+dev = ["pre-commit>=3", "tox"]
+doc = ["sphinx", "sphinx-rtd-theme"]
+
+[tool.tox]
+requires = ["tox>=4.19"]
+env_list = ["doc"]
+
+[tool.tox.env.doc]
+description = "Build the documentation"
+extras = ["doc"]
+commands = [["sphinx-build", "-W", "-b", "html", "doc/", "doc/_build/html"]]
+working_directory = "doc"