From 7f25998a52b5e299d7f4b564b552a2bd68f906ac Mon Sep 17 00:00:00 2001 From: Bruno Willenborg Date: Mon, 13 Sep 2021 17:05:59 +0200 Subject: [PATCH 1/3] drop Gradle build system --- .gitignore | 12 ++-- build.gradle | 12 ---- gradlew | 188 ------------------------------------------------ gradlew.bat | 100 -------------------------- settings.gradle | 0 5 files changed, 6 insertions(+), 306 deletions(-) delete mode 100644 build.gradle delete mode 100644 gradlew delete mode 100644 gradlew.bat delete mode 100644 settings.gradle diff --git a/.gitignore b/.gitignore index feca7a7..8b15d98 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,7 @@ -.gradle/ -gradle.properties -source/_build/* -.idea/* -.vscode/* -build/* +# Folders +source/_build +.idea/ +.vscode/ +build/ + *.iml diff --git a/build.gradle b/build.gradle deleted file mode 100644 index 3f3c6b4..0000000 --- a/build.gradle +++ /dev/null @@ -1,12 +0,0 @@ -plugins { - id "kr.motd.sphinx" version "2.9.0" -} - -apply plugin: 'base' - -sphinx { - sourceDirectory = "${projectDir}/source" - outputDirectory = project.buildDir -} - -tasks.build.finalizedBy(site) \ No newline at end of file diff --git a/gradlew b/gradlew deleted file mode 100644 index b0d6d0a..0000000 --- a/gradlew +++ /dev/null @@ -1,188 +0,0 @@ -#!/usr/bin/env sh - -# -# Copyright 2015 the original author or authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -############################################################################## -## -## Gradle start up script for UN*X -## -############################################################################## - -# Attempt to set APP_HOME -# Resolve links: $0 may be a link -PRG="$0" -# Need this for relative symlinks. -while [ -h "$PRG" ] ; do - ls=`ls -ld "$PRG"` - link=`expr "$ls" : '.*-> \(.*\)$'` - if expr "$link" : '/.*' > /dev/null; then - PRG="$link" - else - PRG=`dirname "$PRG"`"/$link" - fi -done -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >/dev/null -APP_HOME="`pwd -P`" -cd "$SAVED" >/dev/null - -APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` - -# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' - -# Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" - -warn () { - echo "$*" -} - -die () { - echo - echo "$*" - echo - exit 1 -} - -# OS specific support (must be 'true' or 'false'). -cygwin=false -msys=false -darwin=false -nonstop=false -case "`uname`" in - CYGWIN* ) - cygwin=true - ;; - Darwin* ) - darwin=true - ;; - MINGW* ) - msys=true - ;; - NONSTOP* ) - nonstop=true - ;; -esac - -CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar - -# Determine the Java command to use to start the JVM. -if [ -n "$JAVA_HOME" ] ; then - if [ -x "$JAVA_HOME/jre/sh/java" ] ; then - # IBM's JDK on AIX uses strange locations for the executables - JAVACMD="$JAVA_HOME/jre/sh/java" - else - JAVACMD="$JAVA_HOME/bin/java" - fi - if [ ! -x "$JAVACMD" ] ; then - die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME - -Please set the JAVA_HOME variable in your environment to match the -location of your Java installation." - fi -else - JAVACMD="java" - which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. - -Please set the JAVA_HOME variable in your environment to match the -location of your Java installation." -fi - -# Increase the maximum file descriptors if we can. -if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then - MAX_FD_LIMIT=`ulimit -H -n` - if [ $? -eq 0 ] ; then - if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then - MAX_FD="$MAX_FD_LIMIT" - fi - ulimit -n $MAX_FD - if [ $? -ne 0 ] ; then - warn "Could not set maximum file descriptor limit: $MAX_FD" - fi - else - warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" - fi -fi - -# For Darwin, add options to specify how the application appears in the dock -if $darwin; then - GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" -fi - -# For Cygwin, switch paths to Windows format before running java -if $cygwin ; then - APP_HOME=`cygpath --path --mixed "$APP_HOME"` - CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` - JAVACMD=`cygpath --unix "$JAVACMD"` - - # We build the pattern for arguments to be converted via cygpath - ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` - SEP="" - for dir in $ROOTDIRSRAW ; do - ROOTDIRS="$ROOTDIRS$SEP$dir" - SEP="|" - done - OURCYGPATTERN="(^($ROOTDIRS))" - # Add a user-defined pattern to the cygpath arguments - if [ "$GRADLE_CYGPATTERN" != "" ] ; then - OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" - fi - # Now convert the arguments - kludge to limit ourselves to /bin/sh - i=0 - for arg in "$@" ; do - CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` - CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option - - if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition - eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` - else - eval `echo args$i`="\"$arg\"" - fi - i=$((i+1)) - done - case $i in - (0) set -- ;; - (1) set -- "$args0" ;; - (2) set -- "$args0" "$args1" ;; - (3) set -- "$args0" "$args1" "$args2" ;; - (4) set -- "$args0" "$args1" "$args2" "$args3" ;; - (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; - esac -fi - -# Escape application args -save () { - for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done - echo " " -} -APP_ARGS=$(save "$@") - -# Collect all arguments for the java command, following the shell quoting and substitution rules -eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" - -# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong -if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then - cd "$(dirname "$0")" -fi - -exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat deleted file mode 100644 index 9991c50..0000000 --- a/gradlew.bat +++ /dev/null @@ -1,100 +0,0 @@ -@rem -@rem Copyright 2015 the original author or authors. -@rem -@rem Licensed under the Apache License, Version 2.0 (the "License"); -@rem you may not use this file except in compliance with the License. -@rem You may obtain a copy of the License at -@rem -@rem http://www.apache.org/licenses/LICENSE-2.0 -@rem -@rem Unless required by applicable law or agreed to in writing, software -@rem distributed under the License is distributed on an "AS IS" BASIS, -@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -@rem See the License for the specific language governing permissions and -@rem limitations under the License. -@rem - -@if "%DEBUG%" == "" @echo off -@rem ########################################################################## -@rem -@rem Gradle startup script for Windows -@rem -@rem ########################################################################## - -@rem Set local scope for the variables with windows NT shell -if "%OS%"=="Windows_NT" setlocal - -set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. -set APP_BASE_NAME=%~n0 -set APP_HOME=%DIRNAME% - -@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" - -@rem Find java.exe -if defined JAVA_HOME goto findJavaFromJavaHome - -set JAVA_EXE=java.exe -%JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto init - -echo. -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:findJavaFromJavaHome -set JAVA_HOME=%JAVA_HOME:"=% -set JAVA_EXE=%JAVA_HOME%/bin/java.exe - -if exist "%JAVA_EXE%" goto init - -echo. -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:init -@rem Get command-line arguments, handling Windows variants - -if not "%OS%" == "Windows_NT" goto win9xME_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* - -:execute -@rem Setup the command line - -set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar - -@rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% - -:end -@rem End local scope for the variables with windows NT shell -if "%ERRORLEVEL%"=="0" goto mainEnd - -:fail -rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of -rem the _cmd.exe /c_ return code! -if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 -exit /b 1 - -:mainEnd -if "%OS%"=="Windows_NT" endlocal - -:omega diff --git a/settings.gradle b/settings.gradle deleted file mode 100644 index e69de29..0000000 From 9272ac82752d795ec06206586b8f5578dbceaee7 Mon Sep 17 00:00:00 2001 From: Bruno Willenborg Date: Mon, 13 Sep 2021 17:47:59 +0200 Subject: [PATCH 2/3] Added README.md --- README.md | 95 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e524eb1 --- /dev/null +++ b/README.md @@ -0,0 +1,95 @@ + +# 3D City Database User Manual + +The 3DCityDB User Manual is built and hosted on [ReadTheDocs.org](https://readthedocs.org). +Please use the link below to find the online version of this documentation. +A PDF version is available here: + +
+

:arrow_right: https://3dcitydb-docs.readthedocs.io/en/latest/ :arrow_left:

+
+ +![cover_image](source/media/cover_image.png) + +The images on the cover page were provided by: + +- Chair of Photogrammetry and Remote Sensing & Chair of Cartography, Technische Universität München + +- Geobasisdaten: © Stadtvermessung Frankfurt am Main + +- IDAC Ltd, UK. + +- Virtual City Systems, Berlin, Germany + +- Chair of Geoinformatics, Technische Universität München. Image created based on master thesis work of Matthias Körner, jointly supervised with HTW Dresden + +- 3D City Model of Berlin © Berlin Partner GmbH + +- M.O.S.S. Computer Grafik Systeme GmbH, Taufkirchen, Germany + +## How to build this documentation + +### Build with Docker + +To avoid setting up the build environment, it is recommended to use [Docker](https://docs.docker.com/get-docker/) +and [this Docker image](https://github.com/BWibo/sphinx-rtd-docker) to build this documentation. + +#### Build process + +1. Clone this repo and navigate to the repo folder: + + ```bash + git clone https://github.com/3dcitydb/3dcitydb-docs.git + cd 3dcitydb-docs + ``` + +2. Mount the current directory to the images `/docs` folder and build the HTML version: + + ```bash + docker run --rm \ + -v $PWD:/docs \ + bwibo/sphinx-rtd make html + ``` + +3. The build files are in `build/html`. + +### Build in a local Python environment + +To build this documentation following tools are required: + +- Python 3.6+: +- Sphinx: +- Sphinx ReadTheDocs Theme: +- Sphinx copybutton: + +Run this to install all dependencies in an existing Python environment using [pip](https://packaging.python.org/tutorials/installing-packages/https://packaging.python.org/tutorials/installing-packages/): + +```python +pip install -U sphinx +pip install -U -r source/requirements.txt +``` + +#### Build process + +1. Clone this repo and navigate to the repo folder: + + ```bash + git clone https://github.com/3dcitydb/3dcitydb-docs.git + cd 3dcitydb-docs + ``` + +2. Build the HTML version of the documentation: + + - Linux: + + ```bash + make html + ``` + + - Windows: + + ```cmd + make.bat html + ``` + +3. The build files are in `build/html`. From f14dac346e7b8f26b903a40b36053ed8a0d38b1e Mon Sep 17 00:00:00 2001 From: Bruno Willenborg Date: Tue, 14 Sep 2021 09:19:06 +0200 Subject: [PATCH 3/3] Move note to previous docs --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e524eb1..8aab73b 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ The 3DCityDB User Manual is built and hosted on [ReadTheDocs.org](https://readthedocs.org). Please use the link below to find the online version of this documentation. -A PDF version is available here:

:arrow_right: https://3dcitydb-docs.readthedocs.io/en/latest/ :arrow_left:

@@ -62,7 +61,8 @@ To build this documentation following tools are required: - Sphinx ReadTheDocs Theme: - Sphinx copybutton: -Run this to install all dependencies in an existing Python environment using [pip](https://packaging.python.org/tutorials/installing-packages/https://packaging.python.org/tutorials/installing-packages/): +Run this to install all dependencies in an existing Python environment using +[pip](https://packaging.python.org/tutorials/installing-packages/https://packaging.python.org/tutorials/installing-packages/): ```python pip install -U sphinx @@ -93,3 +93,8 @@ pip install -U -r source/requirements.txt ``` 3. The build files are in `build/html`. + +## Documentations of previous versions + +Documentations of previous versions are available as PDF here: +