Merge pull request #19 from fraya/master

Continuous Integration of documents

Author: fraya

.github/workflows/build-test-docs.yml

@@ -0,0 +1,47 @@
+name: Build and test documentation
+
+on:
+  push:
+    # all branches
+    paths:
+      - 'documentation/**/*.rst'
+      - 'documentation/**/conf.py'
+
+  pull_request:
+    # all branches
+    paths:
+      - 'documentation/**/*.rst'
+      - 'documentation/**/conf.py'
+
+  # This enables the Run Workflow button on the Actions tab.
+  workflow_dispatch:
+
+jobs:
+  build-documentation:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Link check
+        uses: addnab/docker-run-action@v3
+        with:
+          image: ghcr.io/fraya/dylan-docs
+          options: -v ${{ github.workspace }}/documentation:/docs
+          run: make linkcheck
+
+      - name: Build docs with Furo theme
+        uses: addnab/docker-run-action@v3
+        with:
+          image: ghcr.io/fraya/dylan-docs
+          options: -v ${{ github.workspace }}/documentation:/docs
+          run: make html
+
+      - name: Upload html artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: strings-doc-html
+          path: documentation/build/html/

README.rst

@@ -6,7 +6,7 @@ This is a strings library for Dylan providing common string and
 character functions.
 
 It was initially described in `DEP-0004
-<http://opendylan.org/proposals/dep-0004.html>`_.
+<https://opendylan.org/proposals/dep-0004-strings-library.html>`_.
 
 It is documented within the `Open Dylan Library Reference
 <http://opendylan.org/documentation/library-reference/>`_.

documentation/source/conf.py

@@ -41,3 +41,6 @@
 
 # sudo pip install -U furo
 html_theme = 'furo'
+
+# Ignore SNI validation errors
+tls_verify = False

documentation/source/index.rst

@@ -8,8 +8,8 @@ The strings Library
 The *strings* library exports definitions for basic string manipulation.
 
 The *strings* library was originally defined in `DEP-0004
-<http://opendylan.org/proposals/dep-0004.html>`_.  Some additional background
-material can be found there.
+<https://opendylan.org/proposals/dep-0004-strings-library.html>`_. Some
+additional background material can be found there.
 
 .. toctree::
    :hidden:
@@ -32,8 +32,8 @@ material can be found there.
     will be updated to support it also.
 
 The strings library was originally defined in `DEP-0004
-<http://opendylan.org/proposals/dep-0004.html>`_.  Some additional
-background material can be found there.
+<https://opendylan.org/proposals/dep-0004-strings-library.html>`_. Some
+additional background material can be found there.
 
 
 The strings Module
@@ -806,7 +806,8 @@ Comparison Functions
 
 Case insensitive character comparison functions are provided for
 convenience.  (See `DEP-0004
-<http://opendylan.org/proposals/dep-0004.html>`_ for discussion.)
+<https://opendylan.org/proposals/dep-0004-strings-library.html>`_. for
+discussion.)
 
 .. function:: char-compare