chore: add build pipeline (#126)

.github/workflows/deploy.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.8'
+          python-version: '3.11'
           cache: 'pip'
 
       - name: Upgrade pip

.github/workflows/pull-request.yml

@@ -0,0 +1,32 @@
+name: Build
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+
+      - name: Upgrade pip
+        run: python3 -m pip install --upgrade pip
+
+      - name: Install dependencies
+        run: python3 -m pip install -r requirements.txt
+
+      - name: Build
+        run: |
+          make html
+          cp -r images _build/html
+          cp CNAME _build/html
+          touch _build/html/.nojekyll

conf.py

@@ -29,7 +29,9 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['m2rr', 'sphinx_material']
+extensions = ['m2r2', 'sphinx_material']
+
+source_suffix = ['.rst', '.md']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -39,6 +41,7 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ['Readme.md', '.github', 'tutorials/template.md', '_build', 'Thumbs.db', '.DS_Store', '.venv']
 
+suppress_warnings = ["config.cache"]
 
 # -- Options for HTML output -------------------------------------------------
 

requirements.txt

@@ -1,34 +1,34 @@
-alabaster~=0.7.12
-Babel~=2.8.0
-beautifulsoup4~=4.9.1
-certifi~=2020.6.20
-chardet~=3.0.4
+alabaster~=1.0.0
+Babel~=2.16.0
+beautifulsoup4~=4.12.3
+certifi~=2024.8.30
+chardet~=5.2.0
 css-html-js-minify~=2.5.5
-docutils~=0.16
-idna~=2.10
-imagesize~=1.2.0
-Jinja2~=2.11.2
-lxml~=4.5.2
-m2rr~=0.2.3
-MarkupSafe~=1.1.1
+docutils~=0.21.2
+idna~=3.8
+imagesize~=1.4.1
+Jinja2~=3.1.4
+lxml~=5.3.0
+m2r2~=0.3.3.post2
+MarkupSafe~=2.1.5
 mistune~=0.8.4
-packaging~=20.4
-Pygments~=2.6.1
-pyparsing~=2.4.7
-python-slugify~=4.0.1
-pytz~=2020.1
-requests~=2.24.0
-six~=1.15.0
-snowballstemmer~=2.0.0
-soupsieve~=2.0.1
-Sphinx~=3.2.1
-sphinx-material~=0.0.30
-sphinxcontrib-applehelp~=1.0.2
-sphinxcontrib-devhelp~=1.0.2
-sphinxcontrib-htmlhelp~=1.0.3
+packaging~=24.1
+Pygments~=2.18.0
+pyparsing~=3.1.4
+python-slugify~=8.0.4
+pytz~=2024.1
+requests~=2.32.3
+six~=1.16.0
+snowballstemmer~=2.2.0
+soupsieve~=2.6
+Sphinx~=8.0.2
+sphinx-material~=0.0.36
+sphinxcontrib-applehelp~=2.0.0
+sphinxcontrib-devhelp~=2.0.0
+sphinxcontrib-htmlhelp~=2.1.0
 sphinxcontrib-jsmath~=1.0.1
-sphinxcontrib-qthelp~=1.0.3
-sphinxcontrib-serializinghtml~=1.1.4
+sphinxcontrib-qthelp~=2.0.0
+sphinxcontrib-serializinghtml~=2.0.0
 text-unidecode~=1.3
-Unidecode~=1.1.1
-urllib3~=1.25.10
+Unidecode~=1.3.8
+urllib3~=2.2.2