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/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..e702418 100644 --- a/docsrc/news.rst +++ b/docsrc/news.rst @@ -3,6 +3,18 @@ News ==== +GeoNetwork at FOSS4G-EU 2025 +------------------------------------------------ + +Date: 20 July 2025 + +* `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 ------------------------------------------------ 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