From df7ac0694dcbc831b00b4669433d1873b72eddbe Mon Sep 17 00:00:00 2001 From: Jody Garnett Date: Tue, 5 Aug 2025 11:53:48 -0700 Subject: [PATCH 1/5] foss4g europe presentations --- README.md | 25 +++++++++++++++++-------- docsrc/news.rst | 9 +++++++++ requirements.txt | 1 + 3 files changed, 27 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d80a9d8..908728d 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ GeoNetwork opensource website project. The content of this repository is deploye ## Website build -### Quick test +### Local build -Quick test on command line: +Quick build on command line: ``` sphinx-build -a -b html docsrc target/website ``` @@ -20,6 +20,15 @@ Or with maven: mvn prepare-package ``` +### Local test + +Test locally in browser while writing: +``` +sphinx-autobuild -a docsrc target/website +``` + +Use browser to preview: http://127.0.0.1:8000 + ### Installing the tools Python virtual environment: @@ -29,9 +38,14 @@ virtualenv venv ``` source venv/bin/activate ``` +``` +pip install -r requirements.txt +``` Sphinx is used to build the documentation: https://sphinx-doc.org/ +The sphinx-autobuild is used for local testing. + The theme is based on [sphinx_rtd_theme](https://github.com/snide/sphinx_rtd_theme) and the sphinx_bootstrap_theme. The internationalization is build used [sphinx-intl](http://www.sphinx-doc.org/es/stable/intl.html) @@ -39,9 +53,4 @@ The internationalization is build used [sphinx-intl](http://www.sphinx-doc.org/e To download the translations from Transifex (optional), you will need the transifex command line client: https://docs.transifex.com/client/installing-the-client -The Transifex Client is written in Python, so it runs on most systems. The easiest way to install it is with pip: - -You can install these with [pip](https://pip.pypa.io/en/stable/installing/): -``` -pip install -r requirements.txt -``` +The Transifex Client is written in Python, so it runs on most systems. The easiest way to install it is with pip: \ No newline at end of file diff --git a/docsrc/news.rst b/docsrc/news.rst index 36fc67b..7a27c6f 100644 --- a/docsrc/news.rst +++ b/docsrc/news.rst @@ -3,6 +3,15 @@ News ==== +GeoNetwork at FOSS4G-EU 2025 +------------------------------------------------ + +Date: 20 July 2025 + +* `geonetwork-ui to sublime your opendata platform `__ +* `State of GeoNetwork 4.4.8 `__ +* `GeoNetwork 5 Status Report `__ + GeoNetwork opensource v4.4.8 released ------------------------------------------------ diff --git a/requirements.txt b/requirements.txt index e525aa8..a7a9c9d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,3 +3,4 @@ sphinx-bootstrap-theme sphinx_rtd_theme sphinx-intl transifex-client +sphinx-autobuild \ No newline at end of file From ce838b77348e8de9f6da579fd3ea849522dc2eaa Mon Sep 17 00:00:00 2001 From: Jody Garnett Date: Wed, 6 Aug 2025 09:56:43 -0700 Subject: [PATCH 2/5] slide and video links now complete --- docsrc/news.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docsrc/news.rst b/docsrc/news.rst index 7a27c6f..e702418 100644 --- a/docsrc/news.rst +++ b/docsrc/news.rst @@ -8,9 +8,12 @@ GeoNetwork at FOSS4G-EU 2025 Date: 20 July 2025 -* `geonetwork-ui to sublime your opendata platform `__ -* `State of GeoNetwork 4.4.8 `__ -* `GeoNetwork 5 Status Report `__ +* `geonetwork-ui to sublime your opendata platform `__ + (`video `_) +* `State of GeoNetwork 4.4.8 `__ + (`video `__) +* `GeoNetwork 5 Status Report `__ + (`video `__) GeoNetwork opensource v4.4.8 released ------------------------------------------------ From bcb7abe9f9a3f2673b428103631446f409c52661 Mon Sep 17 00:00:00 2001 From: Jody Garnett Date: Wed, 6 Aug 2025 10:02:29 -0700 Subject: [PATCH 3/5] build pages on PR --- .github/workflows/website.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/workflows/website.yml diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml new file mode 100644 index 0000000..da51968 --- /dev/null +++ b/.github/workflows/website.yml @@ -0,0 +1,25 @@ +name: buiild website pages + +on: + pull_request: + branches: + - master + workflow_dispatch: + +jobs: + build-docs: + runs-on: ubuntu-latest + steps: + - name: Checkout GeoNetwork Website + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Install Python + uses: actions/setup-python@v5 + with: + python-version: 3.x + - name: sphinx install + run: pip install --upgrade pip && pip install -r requirements.txt + - name: build website pages + run: | + sphinx-build -a -b html docsrc target/website From 1ff74be319f87c479eff898374b0cfe9a7ea1ac6 Mon Sep 17 00:00:00 2001 From: Jody Garnett Date: Wed, 6 Aug 2025 10:07:39 -0700 Subject: [PATCH 4/5] fail warnings on github PR build pages --- .github/workflows/website.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml index da51968..2b5a0e8 100644 --- a/.github/workflows/website.yml +++ b/.github/workflows/website.yml @@ -22,4 +22,4 @@ jobs: run: pip install --upgrade pip && pip install -r requirements.txt - name: build website pages run: | - sphinx-build -a -b html docsrc target/website + sphinx-build -n -W -a -b html docsrc target/website From a215cc65fa4ab4f87f656f60bf56e1b7c182758f Mon Sep 17 00:00:00 2001 From: Jody Garnett Date: Wed, 6 Aug 2025 10:11:21 -0700 Subject: [PATCH 5/5] remove duplicate QA check --- .github/workflows/docs.yml | 2 +- .github/workflows/website.yml | 25 ------------------------- 2 files changed, 1 insertion(+), 26 deletions(-) delete mode 100644 .github/workflows/website.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 9da57ca..cde83f1 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -26,7 +26,7 @@ jobs: pip install -r requirements.txt - name: Build docs run: | - sphinx-build -a -b html docsrc target/website + sphinx-build -n -W -a -b html docsrc target/website - name: Check index.html run: | if test ! -f target/website/index.html; then diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml deleted file mode 100644 index 2b5a0e8..0000000 --- a/.github/workflows/website.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: buiild website pages - -on: - pull_request: - branches: - - master - workflow_dispatch: - -jobs: - build-docs: - runs-on: ubuntu-latest - steps: - - name: Checkout GeoNetwork Website - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - name: Install Python - uses: actions/setup-python@v5 - with: - python-version: 3.x - - name: sphinx install - run: pip install --upgrade pip && pip install -r requirements.txt - - name: build website pages - run: | - sphinx-build -n -W -a -b html docsrc target/website