Merge pull request #359 from niccokunzmann/docs-tox

use tox to build the documentation

.github/workflows/tests.yml

@@ -21,6 +21,7 @@ jobs:
         - ["3.9",   "py39"]
         - ["3.10",  "py310"]
         - ["pypy3", "pypy3"]
+        - ["3.10",  "docs"]
 
     runs-on: ubuntu-latest
     name: ${{ matrix.config[1] }}

docs/install.rst

@@ -129,3 +129,10 @@ To build the documentation follow these steps:
 You can now open the output from ``_build/html/index.html``. To build the
 presentation-version use ``make presentation`` instead of ``make html``. You
 can open the presentation at ``presentation/index.html``.
+
+You can also use ``tox`` to build the documentation:
+
+.. code-block:: bash
+
+    cd icalendar
+    tox -e docs

tox.ini

@@ -1,6 +1,6 @@
 # to run for a specific environment, use ``tox -e ENVNAME``
 [tox]
-envlist = py27,py37,py38,py39,py310,pypy3
+envlist = py27,py37,py38,py39,py310,pypy3,docs
 
 [testenv]
 usedevelop=True
@@ -13,3 +13,11 @@ commands =
     py{27}: coverage run --append --source=src/icalendar --omit=*/tests/* --module pytest [] src/icalendar/tests/hypothesis/
     coverage report
     coverage html
+
+[testenv:docs]
+deps =
+    -r {toxinidir}/requirements_docs.txt
+changedir = docs
+allowlist_externals = make
+commands =
+    make html