From 76b7ac74cb28a8265a690c5db4be2f50252f759b Mon Sep 17 00:00:00 2001 From: David Linke Date: Wed, 18 Dec 2024 17:39:28 +0100 Subject: [PATCH] Fix docs-skeleton to run without warnings --- .github/workflows/ci-pr.yml | 4 +-- .github/workflows/merge.yml | 7 ++--- docs/_static/fig_A.svg | 53 +++++++++++++++++++++++++++++++++++++ docs/_static/fig_B.svg | 52 ++++++++++++++++++++++++++++++++++++ docs/_static/fig_C.svg | 50 ++++++++++++++++++++++++++++++++++ docs/index.md | 14 +++++----- 6 files changed, 165 insertions(+), 15 deletions(-) create mode 100644 docs/_static/fig_A.svg create mode 100644 docs/_static/fig_B.svg create mode 100644 docs/_static/fig_C.svg diff --git a/.github/workflows/ci-pr.yml b/.github/workflows/ci-pr.yml index 315b479..1fccfe3 100644 --- a/.github/workflows/ci-pr.yml +++ b/.github/workflows/ci-pr.yml @@ -1,7 +1,7 @@ # This action runs when a pull request to main is created or updated # (but not when it is merged into main). -name: CI on pull request create or update +name: Test build for PRs on: pull_request_target: branches: @@ -47,7 +47,6 @@ jobs: # install tagged version python -m pip install -r docs/requirements.txt -XXX - name: Set dynamic environment variables. run: | echo "RUN_DATE=$(date +'%Y-%m-%dT%H%M')" >> $GITHUB_ENV @@ -57,7 +56,6 @@ XXX sphinx-build --nitpicky --fail-on-warning --keep-going docs docs/_build cp -r docs/_build/. publish/ - - name: Store publish dir (=pages) as artifact # This step is not required and may be removed. # It may be helpful for trouble shooting. diff --git a/.github/workflows/merge.yml b/.github/workflows/merge.yml index 6bc464b..631d296 100644 --- a/.github/workflows/merge.yml +++ b/.github/workflows/merge.yml @@ -2,13 +2,10 @@ # # Workflow steps: # - checkout gh-pages for updating -# - create joined vocabulary file in addition to split version -# - create excel-file from turtle -# - build pyLODE docs # - build sphinx docs/site -# - publish docs, vocabulary-turtle files and excel-file to gh-pages +# - publish new docs to gh-pages -name: Build +name: Build docs on: push: branches: diff --git a/docs/_static/fig_A.svg b/docs/_static/fig_A.svg new file mode 100644 index 0000000..5c8a1bb --- /dev/null +++ b/docs/_static/fig_A.svg @@ -0,0 +1,53 @@ + + + + + + + + A + + diff --git a/docs/_static/fig_B.svg b/docs/_static/fig_B.svg new file mode 100644 index 0000000..6707aa5 --- /dev/null +++ b/docs/_static/fig_B.svg @@ -0,0 +1,52 @@ + + + + + + + + B + + diff --git a/docs/_static/fig_C.svg b/docs/_static/fig_C.svg new file mode 100644 index 0000000..7d084fe --- /dev/null +++ b/docs/_static/fig_C.svg @@ -0,0 +1,50 @@ + + + + + + + + C + + diff --git a/docs/index.md b/docs/index.md index e30dc05..d7050b9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,10 +9,10 @@ This is work in progress... ::::{grid} 3 :::{grid-item-card} :link: https://github.com/nfdi4cat/repo4cat/ -**Documentation**, preview +**Link A**, Anna ^^^ -```{image} _static/voc4cat-pylode-docs.png +```{image} _static/fig_A.svg :align: center :alt: screenshot of documentation ``` @@ -23,10 +23,10 @@ This is work in progress... :::{grid-item-card} :link: https://github.com/nfdi4cat/repo4cat/ -**Link 2**, file2 +**Link B**, Berta ^^^ -```{image} _static/voc4cat-concept-sheet.png +```{image} _static/fig_B.svg :align: center :alt: screenshot of file ``` @@ -35,11 +35,11 @@ This is work in progress... ::: :::{grid-item-card} -:link: https://w3id.org/nfdi4cat/voc4cat -**Link 3**, file3 +:link: https://w3id.org/nfdi4cat/repo4cat/ +**Link C**, Charla ^^^ -```{image} _static/voc4cat-concept-sheet.png +```{image} _static/fig_C.svg :align: center :alt: screenshot of file 3 ```