Migrating Sphinx build to Gradle

stages:

  - build

  - test

  - deploy

build:

  stage: build

  script: ./gradlew assemble

test:

  stage: test

  script: ./gradlew test

deploy:

  stage: deploy

  script: 

    - ./gradlew publish $NEXUS_CREDENTIALS

  only:

    - master

docs:

  stage: deploy

  script:

    - |

      if [[ $VERSION = *"SNAPSHOT" || $VERSION = *"RELEASE" ]]; then

        echo "Building documentation for $ARTIFACT $VERSION"

        cd docs

        echo "-- Setting up Virtualenv"

        virtualenv venv

        pwd

        . venv/bin/activate

        echo "-- Installing requirements"

        pip install -r requirements.txt

        echo "-- Building HTML version within $(pwd)"

        make clean html

        echo "-- Creating package"

        fpm -t deb -a noarch -s dir --name dme-doc \

                              --description='DARIAH-DE DME Documentation' \

                              --maintainer='DARIAH-DE <info@de.dariah.eu>' \

                              --vendor='DARIAH-DE' \

                              --url='https://dme.de.dariah.eu' \

                              --version $VERSION \

                              -x ".git**" \

                              -x "**/.git**" \

                              -x "**/.hg**" \

                              -x "**/.svn**" \

                              -x ".buildinfo" \

                              -x "**/*.deb" \

                              --prefix /var/www/doc/dme \

                              -C _build/html .

        ~/scripts/push_deb_packages.sh ./

      fi

  only:

    - master

    - docs

 No newline at end of file

# Makefile for Sphinx documentation

#

# You can set these variables from the command line.

SPHINXOPTS    =

SPHINXBUILD   = sphinx-build

PAPER         =

BUILDDIR      = _build

# User-friendly check for sphinx-build

ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)

$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)

endif

# Internal variables.

PAPEROPT_a4     = -D latex_paper_size=a4

PAPEROPT_letter = -D latex_paper_size=letter

ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

# the i18n builder cannot share the environment and doctrees with the others

I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext

help:

	@echo "Please use \`make <target>' where <target> is one of"

	@echo "  html       to make standalone HTML files"

	@echo "  dirhtml    to make HTML files named index.html in directories"

	@echo "  singlehtml to make a single large HTML file"

	@echo "  pickle     to make pickle files"

	@echo "  json       to make JSON files"

	@echo "  htmlhelp   to make HTML files and a HTML help project"

	@echo "  qthelp     to make HTML files and a qthelp project"

	@echo "  applehelp  to make an Apple Help Book"

	@echo "  devhelp    to make HTML files and a Devhelp project"

	@echo "  epub       to make an epub"

	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"

	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"

	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"

	@echo "  text       to make text files"

	@echo "  man        to make manual pages"

	@echo "  texinfo    to make Texinfo files"

	@echo "  info       to make Texinfo files and run them through makeinfo"

	@echo "  gettext    to make PO message catalogs"

	@echo "  changes    to make an overview of all changed/added/deprecated items"

	@echo "  xml        to make Docutils-native XML files"

	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"

	@echo "  linkcheck  to check all external links for integrity"

	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"

	@echo "  coverage   to run coverage check of the documentation (if enabled)"

clean:

	rm -rf $(BUILDDIR)/*

html:

	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

	@echo

	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

dirhtml:

	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

	@echo

	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

singlehtml:

	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml

	@echo

	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

pickle:

	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle

	@echo

	@echo "Build finished; now you can process the pickle files."

json:

	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json

	@echo

	@echo "Build finished; now you can process the JSON files."

htmlhelp:

	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp

	@echo

	@echo "Build finished; now you can run HTML Help Workshop with the" \

	      ".hhp project file in $(BUILDDIR)/htmlhelp."

qthelp:

	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp

	@echo

	@echo "Build finished; now you can run "qcollectiongenerator" with the" \

	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"

	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/tgimport.qhcp"

	@echo "To view the help file:"

	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/tgimport.qhc"

applehelp:

	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp

	@echo

	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."

	@echo "N.B. You won't be able to view it unless you put it in" \

	      "~/Library/Documentation/Help or install it in your application" \

	      "bundle."

devhelp:

	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp

	@echo

	@echo "Build finished."

	@echo "To view the help file:"

	@echo "# mkdir -p $$HOME/.local/share/devhelp/tgimport"

	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/tgimport"

	@echo "# devhelp"

epub:

	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub

	@echo

	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

latex:

	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

	@echo

	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."

	@echo "Run \`make' in that directory to run these through (pdf)latex" \

	      "(use \`make latexpdf' here to do that automatically)."

latexpdf:

	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

	@echo "Running LaTeX files through pdflatex..."

	$(MAKE) -C $(BUILDDIR)/latex all-pdf

	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

latexpdfja:

	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

	@echo "Running LaTeX files through platex and dvipdfmx..."

	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja

	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

text:

	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text

	@echo

	@echo "Build finished. The text files are in $(BUILDDIR)/text."

man:

	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man

	@echo

	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

texinfo:

	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo

	@echo

	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."

	@echo "Run \`make' in that directory to run these through makeinfo" \

	      "(use \`make info' here to do that automatically)."

info:

	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo

	@echo "Running Texinfo files through makeinfo..."

	make -C $(BUILDDIR)/texinfo info

	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

gettext:

	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale

	@echo

	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

changes:

	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes

	@echo

	@echo "The overview file is in $(BUILDDIR)/changes."

linkcheck:

	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck

	@echo

	@echo "Link check complete; look for any errors in the above output " \

	      "or in $(BUILDDIR)/linkcheck/output.txt."

doctest:

	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest

	@echo "Testing of doctests in the sources finished, look at the " \

	      "results in $(BUILDDIR)/doctest/output.txt."

coverage:

	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage

	@echo "Testing of coverage in the sources finished, look at the " \

	      "results in $(BUILDDIR)/coverage/python.txt."

xml:

	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml

	@echo

	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."

pseudoxml:

	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml

	@echo

	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

plugins {

  id "kr.motd.sphinx" version "2.6.1"

}

// Apply the 'base' plugin, which adds the 'site' task.

// Note: You do not need to apply the 'base' plugin if you applied

//       other plugin that extends 'base', such as 'java'.

apply plugin: 'base'

sphinx {

  sourceDirectory = "${projectDir}"

  outputDirectory = "${project.buildDir}/html"

}

 No newline at end of file

#!/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

#

#      https://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 or MSYS, switch paths to Windows format before running java

if [ "$cygwin" = "true" -o "$msys" = "true" ] ; 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" "$@"