Merge pull request #171 from fraya/master

Update testworks documentation CI

.github/workflows/build-docs.yml

@@ -29,25 +29,30 @@ jobs:
     steps:
 
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      # Until dylan-lang/install-dylan-tool
-      # updates the version
-      - name: Install Open Dylan
-        uses: dylan-lang/install-opendylan@v3
+      - name: Check links
+        uses: addnab/docker-run-action@v3
         with:
-          version: 2023.1
-          tag: v2023.1.0
+          image: ghcr.io/fraya/dylan-docs
+          options: -v ${{ github.workspace }}/documentation:/docs
+          run: make linkcheck
 
-      - name: Install sphinx-extensions dependencies
-        run: |
-          dylan update 
+      - 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: Build docs
-        uses: ammaraskar/sphinx-action@master
+      - name: Upload html artifact
+        uses: actions/upload-artifact@v4
         with:
-          pre-build-command: "echo furo >> documentation/requirements.txt"
-          docs-folder: "documentation/"
+          name: testworks-doc-html
+          path: documentation/build/html/
+
+      - name: Bypassing Jekyll on GH Pages
+        run: sudo touch documentation/build/html/.nojekyll
 
       - name: Deploy documents to GH pages
         uses: JamesIves/github-pages-deploy-action@v4

.gitignore

@@ -1,3 +1,7 @@
-_build
+_build/
 .idea
 *.iml
+_packages/
+registry/
+*~
+documentation/build/

documentation/source/conf.py

@@ -13,16 +13,16 @@
 
 import os
 import sys
-# Substitute version '0.2.0' for 'current' when available
-sys.path.insert(0, os.path.abspath('../../_packages/sphinx-extensions/0.2.0/src/sphinxcontrib'))
+sys.path.insert(0, os.path.abspath('../../_packages/sphinx-extensions/current/src/sphinxcontrib'))
 import dylan.themes as dylan_themes
 
 # -- Project information -----------------------------------------------------
 
 project = 'dylan-libraries'
 copyright = '2023, Dylan Hackers'
 author = 'Dylan Hackers'
-
+release = 'v3.0.0'
+version = release
 
 # -- General configuration -----------------------------------------------------
 
@@ -110,3 +110,6 @@
 epub_author = u'Dylan Hackers'
 epub_publisher = u'Dylan Hackers'
 epub_copyright = u'2023, Dylan Hackers'
+
+# Ignore certification verification
+tls_verify = False

documentation/source/reference.rst

@@ -5,9 +5,6 @@ Testworks Reference
 .. current-library:: testworks
 .. current-module:: testworks
 
-.. contents::  Contents
-   :local:
-
 See also: :doc:`usage`
 
 The *testworks* library exports a single module named *testworks*.

documentation/source/usage.rst

@@ -4,9 +4,6 @@ Testworks Usage
 .. current-library:: testworks
 .. current-module:: testworks
 
-.. contents::  Contents
-   :local:
-
 Testworks is a Dylan unit testing library.
 
 See also: :doc:`reference`