From 44244ee594e98f65e9edb1b2249a7226bf30bf7e Mon Sep 17 00:00:00 2001 From: Fernando Raya Date: Mon, 12 Feb 2024 18:36:49 +0100 Subject: [PATCH 1/6] Replace sphinx-extensions path version for current --- documentation/source/conf.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/documentation/source/conf.py b/documentation/source/conf.py index 5cd4b16..dfe86b0 100644 --- a/documentation/source/conf.py +++ b/documentation/source/conf.py @@ -13,8 +13,7 @@ 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 ----------------------------------------------------- From ff0f96fc4016d13680f298196b5dddb18d1142c8 Mon Sep 17 00:00:00 2001 From: Fernando Raya Date: Mon, 12 Feb 2024 18:39:01 +0100 Subject: [PATCH 2/6] Add develoment directories to .gitignore --- .gitignore | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 41d5f0a..ed822fd 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ -_build +_build/ .idea *.iml +_packages/ +registry/ +*~ +documentation/build/ \ No newline at end of file From 0689f6e964093ff4748f23050f9f767d9c227df8 Mon Sep 17 00:00:00 2001 From: Fernando Raya Date: Mon, 12 Feb 2024 19:26:57 +0100 Subject: [PATCH 3/6] Add version to generate Epub documentation Epub needs a `version` variable. Since we don't separate them, point both to the same value. --- documentation/source/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/source/conf.py b/documentation/source/conf.py index dfe86b0..29b8c70 100644 --- a/documentation/source/conf.py +++ b/documentation/source/conf.py @@ -21,7 +21,8 @@ project = 'dylan-libraries' copyright = '2023, Dylan Hackers' author = 'Dylan Hackers' - +release = 'v3.0.0' +version = release # -- General configuration ----------------------------------------------------- From bdac92726af516062e54a8b7934211bd5e8410ca Mon Sep 17 00:00:00 2001 From: Fernando Raya Date: Mon, 12 Feb 2024 19:32:36 +0100 Subject: [PATCH 4/6] Ignore certification verification Avoid library timeouts to allow GH Actions to pass. --- documentation/source/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/documentation/source/conf.py b/documentation/source/conf.py index 29b8c70..66aaf8c 100644 --- a/documentation/source/conf.py +++ b/documentation/source/conf.py @@ -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 From 3b1a753602c7442110610331997102c3ed67af5e Mon Sep 17 00:00:00 2001 From: Fernando Raya Date: Mon, 12 Feb 2024 19:39:47 +0100 Subject: [PATCH 5/6] Remove table of contents Disable table of contents not compatible with 'Furo' theme --- documentation/source/reference.rst | 3 --- documentation/source/usage.rst | 3 --- 2 files changed, 6 deletions(-) diff --git a/documentation/source/reference.rst b/documentation/source/reference.rst index 6ea6d22..9dd7def 100644 --- a/documentation/source/reference.rst +++ b/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*. diff --git a/documentation/source/usage.rst b/documentation/source/usage.rst index dfd06ac..84c636d 100644 --- a/documentation/source/usage.rst +++ b/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` From 63e19ff5e3cc5546bf07c6e34fc6fcab26ad0329 Mon Sep 17 00:00:00 2001 From: Fernando Raya Date: Mon, 12 Feb 2024 19:44:00 +0100 Subject: [PATCH 6/6] Update CI docs - Update checkout version - Check links - Generate docs - Upload document artifacts - Bypassing Jekyll on GH Pages --- .github/workflows/build-docs.yml | 33 ++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 385f5fa..6f9891e 100644 --- a/.github/workflows/build-docs.yml +++ b/.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