Merge pull request #35 from fraya/doc-update

Doc update

Author: fraya

.github/workflows/build-docs.yml renamed to .github/workflows/build-and-deploy-docs.yml

@@ -1,14 +1,10 @@
-name: Build documentation
+name: Build and deploy docs
 
 on:
   push:
     # all branches
     paths:
       - 'documentation/**'
-  pull_request:
-    # all branches
-    paths:
-      - 'documentation/**'
 
   # This enables the Run Workflow button on the Actions tab.
   workflow_dispatch:

.github/workflows/check-docs.yml

@@ -0,0 +1,42 @@
+name: Check documentation
+
+on:
+  pull_request:
+    # all branches
+    paths:
+      - 'documentation/**'
+
+  # This enables the Run Workflow button on the Actions tab.
+  workflow_dispatch:
+
+# https://github.com/JamesIves/github-pages-deploy-action#readme
+permissions:
+    contents: write
+
+# Set DYLAN environment variable to GITHUB_WORKSPACE so packages are
+# installed in ../../_packages relative to documentation's Makefile
+env:
+  DYLAN: ${{ github.workspace }}
+
+jobs:
+
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Check links
+        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

documentation/source/index.rst

@@ -18,15 +18,15 @@ at `GitHub
 
 Inspiration for this library is taken among others from the defstorage
 system available as part of the `Genera Common Lisp operating system
-<http://en.wikipedia.org/wiki/Genera_%28operating_system%29>`_ and the
+<https://en.wikipedia.org/wiki/Genera_%28operating_system%29>`_ and the
 swiss-army knife for interactive packet manipulation `scapy (Web archive)
 <http://web.archive.org/web/20131217022133/http://bb.secdev.org/scapy/wiki/Home>`__.
 
 For further information, you might want to read our published papers
 about a TCP/IP stack written entirely in Dylan:
 
-* :download:`A domain-specific language for manipulation of binary data in Dylan <../papers/a-DSL-for-manipulation-of-binary-data.pdf>` (by Hannes Mehnert and Andreas Bogk at ILC 2007)
-* :download:`Secure Networking <../papers/secure-networking.pdf>` (by Andreas Bogk and Hannes Mehnert in 2006)
+* :download:`A domain-specific language for manipulation of binary data in Dylan <./papers/a-DSL-for-manipulation-of-binary-data.pdf>` (by Hannes Mehnert and Andreas Bogk at ILC 2007)
+* :download:`Secure Networking <./papers/secure-networking.pdf>` (by Andreas Bogk and Hannes Mehnert in 2006)
 
 .. toctree::
    :maxdepth: 3

documentation/papers/a-DSL-for-manipulation-of-binary-data.pdf renamed to documentation/source/papers/a-DSL-for-manipulation-of-binary-data.pdf

@@ -964,7 +964,7 @@ Predefined Leaf Frames
    :operations:
 
       - :gf:`high-level-type` returns `<byte>
-        https://opendylan.org/library-reference/common-dylan/byte-vector.html#common-dylan:byte-vector:[byte]`_.
+        <https://opendylan.org/library-reference/common-dylan/byte-vector.html#common-dylan:byte-vector:[byte]>`_.
       - :gf:`field-size` returns 8.
 
    :superclasses: :class:`<fixed-size-translated-leaf-frame>`