diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-and-deploy-docs.yml similarity index 93% rename from .github/workflows/build-docs.yml rename to .github/workflows/build-and-deploy-docs.yml index 1b554a9..af5ead4 100644 --- a/.github/workflows/build-docs.yml +++ b/.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: diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml new file mode 100644 index 0000000..97bca76 --- /dev/null +++ b/.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 diff --git a/documentation/source/index.rst b/documentation/source/index.rst index 76b573c..51fe94e 100644 --- a/documentation/source/index.rst +++ b/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 -`_ and the +`_ and the swiss-army knife for interactive packet manipulation `scapy (Web archive) `__. 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 diff --git a/documentation/papers/a-DSL-for-manipulation-of-binary-data.pdf b/documentation/source/papers/a-DSL-for-manipulation-of-binary-data.pdf similarity index 100% rename from documentation/papers/a-DSL-for-manipulation-of-binary-data.pdf rename to documentation/source/papers/a-DSL-for-manipulation-of-binary-data.pdf diff --git a/documentation/papers/secure-networking.pdf b/documentation/source/papers/secure-networking.pdf similarity index 100% rename from documentation/papers/secure-networking.pdf rename to documentation/source/papers/secure-networking.pdf diff --git a/documentation/source/reference.rst b/documentation/source/reference.rst index e172afa..2707e6b 100644 --- a/documentation/source/reference.rst +++ b/documentation/source/reference.rst @@ -964,7 +964,7 @@ Predefined Leaf Frames :operations: - :gf:`high-level-type` returns ` - https://opendylan.org/library-reference/common-dylan/byte-vector.html#common-dylan:byte-vector:[byte]`_. + `_. - :gf:`field-size` returns 8. :superclasses: :class:``