From 07d4f6a73ab206413baed767a7ec8afd14e3e384 Mon Sep 17 00:00:00 2001 From: Fernando Raya Date: Tue, 11 Mar 2025 09:51:13 +0100 Subject: [PATCH 1/4] doc: Update link http -> https --- documentation/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/source/index.rst b/documentation/source/index.rst index 76b573c..e2421fc 100644 --- a/documentation/source/index.rst +++ b/documentation/source/index.rst @@ -18,7 +18,7 @@ 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) `__. From 457ab39e1edeaea1c920c70113ab2d41a64687d9 Mon Sep 17 00:00:00 2001 From: Fernando Raya Date: Tue, 11 Mar 2025 23:21:32 +0100 Subject: [PATCH 2/4] doc: Fix link --- documentation/source/reference.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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:`` From c8fb1d0c0a42df234eb5e8341529f3ca357d49ae Mon Sep 17 00:00:00 2001 From: Fernando Raya Date: Wed, 12 Mar 2025 17:08:46 +0100 Subject: [PATCH 3/4] doc: Move papers/ to source/ Avoids an error generating the website, where the directory papers/ is not copied because is in the parent directory of source/. Closes #33 --- documentation/source/index.rst | 4 ++-- .../a-DSL-for-manipulation-of-binary-data.pdf | Bin .../{ => source}/papers/secure-networking.pdf | Bin 3 files changed, 2 insertions(+), 2 deletions(-) rename documentation/{ => source}/papers/a-DSL-for-manipulation-of-binary-data.pdf (100%) rename documentation/{ => source}/papers/secure-networking.pdf (100%) diff --git a/documentation/source/index.rst b/documentation/source/index.rst index e2421fc..51fe94e 100644 --- a/documentation/source/index.rst +++ b/documentation/source/index.rst @@ -25,8 +25,8 @@ 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 From 240332cd362d647ec11484adea1ae0845a470352 Mon Sep 17 00:00:00 2001 From: Fernando Raya Date: Wed, 12 Mar 2025 17:25:04 +0100 Subject: [PATCH 4/4] ci: Separate document deployment from pull request checks Separate the task of checking document links and building them from the deployment to GitHub Pages. The GitHub Actions runner lacks the necessary privileges to deploy the documentation during pull requests, which caused link checking errors. --- ...ild-docs.yml => build-and-deploy-docs.yml} | 6 +-- .github/workflows/check-docs.yml | 42 +++++++++++++++++++ 2 files changed, 43 insertions(+), 5 deletions(-) rename .github/workflows/{build-docs.yml => build-and-deploy-docs.yml} (93%) create mode 100644 .github/workflows/check-docs.yml 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