diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index b143c68a76c37bb0552b45ba7aef3aff10f5140d..6faf96fc798aaaf07afdf3c1cc4fa7694cc54ed9 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,5 +1,6 @@ stages: - static + - dynamic default: tags: @@ -12,3 +13,25 @@ static-copy: script: - ls ./Documentation/html/ - sshpass -p "$WOLKE_PASSWORD" rsync -autv --delete -e "ssh -o StrictHostKeyChecking=no" ./Documentation/html/* "$WOLKE_USER@wolke.img.univie.ac.at:/var/www/flexpart/flexextract" + +build: + image: harbor.wolke.img.univie.ac.at/podman/flexextract_sphinx:latest + stage: dynamic + when: manual + script: + # --strict is too strict :) + - cd For_Developers/Sphinx + - make html + artifacts: + paths: + - For_Developers/Sphinx/Documentation/html/* + expire_in: 60 seconds + +deploy: + stage: dynamic + image: harbor.wolke.img.univie.ac.at/podman/alpine-sshpass:latest + when: manual + needs: + - build + script: + - sshpass -p "$WOLKE_PASSWORD" rsync -autv --delete -e "ssh -o StrictHostKeyChecking=no" ./For_Developers/Sphinx/Documentation/html/* "$WOLKE_USER@wolke.img.univie.ac.at:/var/www/flexpart/flexextract" diff --git a/For_developers/Sphinx/Dockerfile b/For_developers/Sphinx/Dockerfile new file mode 100644 index 0000000000000000000000000000000000000000..cb1962b17d0494bf2205502ae6e6a7f70a30d5c9 --- /dev/null +++ b/For_developers/Sphinx/Dockerfile @@ -0,0 +1,12 @@ +FROM python:3.7-slim-bullseye +# install everything +RUN apt-get update -y \ + && apt-get install -y -qq texlive texlive-latex-extra pandoc build-essential \ + && apt-get clean all +ADD requirements.txt /requirements.txt +RUN pip install --no-cache -r requirements.txt +# build the documentation with sphinx? +#ADD ./Source /doc/Source +#ADD ./Makefile /doc/Makefile +WORKDIR /doc +#RUN make html \ No newline at end of file diff --git a/For_developers/Sphinx/Makefile b/For_developers/Sphinx/Makefile index 3e83469c646fd3c4224848182cbc3213ff779f42..a9ab3e6d80d536c5637ad3d4d84a6baa52e58f11 100644 --- a/For_developers/Sphinx/Makefile +++ b/For_developers/Sphinx/Makefile @@ -6,7 +6,7 @@ SPHINXOPTS = -d Build_temp SPHINXBUILD = sphinx-build SPHINXPROJ = flex_extract SOURCEDIR = Source -BUILDDIR = ../../Documentation +BUILDDIR = Documentation # Put it first so that "make" without argument is like "make help". help: diff --git a/For_developers/Sphinx/Source/_files/CONTROLparameter.xls b/For_developers/Sphinx/Source/_files/CONTROLparameter.xls deleted file mode 120000 index 4cbc0645bdc26c3204e0aa8a8a4c6a9a488b94e6..0000000000000000000000000000000000000000 --- a/For_developers/Sphinx/Source/_files/CONTROLparameter.xls +++ /dev/null @@ -1 +0,0 @@ -../../../CONTROLparameter.xls \ No newline at end of file diff --git a/For_developers/Sphinx/Source/_files/CONTROLparameter.xls b/For_developers/Sphinx/Source/_files/CONTROLparameter.xls new file mode 100644 index 0000000000000000000000000000000000000000..c6cfbc81cf8d5d1ac0a383b12e2a440a82322937 Binary files /dev/null and b/For_developers/Sphinx/Source/_files/CONTROLparameter.xls differ diff --git a/For_developers/Sphinx/Source/_files/InstallationParameter.xls b/For_developers/Sphinx/Source/_files/InstallationParameter.xls deleted file mode 120000 index 1827ba8decc55d5aaea13962f42751f9e9f2cc1a..0000000000000000000000000000000000000000 --- a/For_developers/Sphinx/Source/_files/InstallationParameter.xls +++ /dev/null @@ -1 +0,0 @@ -../../../InstallationParameter.xls \ No newline at end of file diff --git a/For_developers/Sphinx/Source/_files/InstallationParameter.xls b/For_developers/Sphinx/Source/_files/InstallationParameter.xls new file mode 100644 index 0000000000000000000000000000000000000000..5a7ab0dd2d436c1fe93ee25269ed51865f8e6f8a Binary files /dev/null and b/For_developers/Sphinx/Source/_files/InstallationParameter.xls differ diff --git a/For_developers/Sphinx/Source/_files/SubmitParameters.xls b/For_developers/Sphinx/Source/_files/SubmitParameters.xls deleted file mode 120000 index 6162da7624ddba46436a695868e205415290a954..0000000000000000000000000000000000000000 --- a/For_developers/Sphinx/Source/_files/SubmitParameters.xls +++ /dev/null @@ -1 +0,0 @@ -../../../SubmitParameters.xls \ No newline at end of file diff --git a/For_developers/Sphinx/Source/_files/SubmitParameters.xls b/For_developers/Sphinx/Source/_files/SubmitParameters.xls new file mode 100644 index 0000000000000000000000000000000000000000..f73e63b16b4570d110ef24a30c508a27d8666fd0 Binary files /dev/null and b/For_developers/Sphinx/Source/_files/SubmitParameters.xls differ diff --git a/For_developers/Sphinx/Source/conf.py b/For_developers/Sphinx/Source/conf.py index 7110349c3558443e754ed5685156f93e85480624..b7253957248c459ec0a2f4d87bdd22d2d67aee4f 100644 --- a/For_developers/Sphinx/Source/conf.py +++ b/For_developers/Sphinx/Source/conf.py @@ -17,7 +17,6 @@ import sys, glob sys.path.insert(0, os.path.abspath('../../../Source/Python')) sys.path.insert(0, os.path.abspath('../../../Source/Python/Mods')) sys.path.insert(0, os.path.abspath('../../../Source/Python/Classes')) - sys.path.insert(0, os.path.abspath('_static/python')) sys.setrecursionlimit(1500) diff --git a/For_developers/Sphinx/requirements.txt b/For_developers/Sphinx/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..46acc2db8f8e06de4aad1f2cc43cdc8de11f8e84 --- /dev/null +++ b/For_developers/Sphinx/requirements.txt @@ -0,0 +1,17 @@ +# using Python 3.7 latest +# not sure about the version, but sphinx must be version 1.? +# documentation tool +sphinx==1.8.5 +sphinx_rtd_theme +sphinxcontrib-seqdiag +sphinxcontrib-exceltable +sphinx-jsonschema +sphinxcontrib-blockdiag +seqdiag>=0.9.3,<2 +graphviz +mock +pytest +pylint +pycallgraph +Jinja2<3.1 +blockdiag>=1.5.4,<2 \ No newline at end of file diff --git a/README.md b/README.md index 27fbaaf14450b205eebbc60bd5faa0afd177a11b..4e5471683d40315e051fce12582e329878484c25 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ `flex_extract` is a software package to support retrieving meteorological fields from the European Centre for Medium-Range Weather Forecasts' (ECMWF) Meteorological Archival and Retrieval System (MARS) as input for the `FLEXTRA`/`FLEXPART` Atmospheric Transport Modelling system. -`FLEXPART` (“FLEXible PARTicle dispersion model”, http://flexpart.eu) is a Lagrangian transport and dispersion model suitable for the simulation of a large range of atmospheric transport processes. +`FLEXPART` (“FLEXible PARTicle dispersion model”, [flexpart.eu](http://flexpart.eu)) is a Lagrangian transport and dispersion model suitable for the simulation of a large range of atmospheric transport processes. ## Installation and Usage @@ -12,7 +12,7 @@ Please open the file Documentation/html/index.html in your preferred browser to ## Project website -https://www.flexpart.eu/wiki/FpInputMetEcmwf +[flexpart.img.univie.ac.at/flexextract](https://www.flexpart.img.univie.ac.at/flexextract) ## Authors diff --git a/test.txt b/test.txt deleted file mode 100644 index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000