To receive notifications about scheduled maintenance, please subscribe to the mailing-list gitlab-operations@sympa.ethz.ch. You can subscribe to the mailing-list at https://sympa.ethz.ch

Commit bfb9f6fb authored by mastc's avatar mastc 🎯
Browse files

Developer

parent f0dd825d
...@@ -53,7 +53,9 @@ coverage: ...@@ -53,7 +53,9 @@ coverage:
pages: pages:
stage: documentation stage: documentation
script: script:
- mkdir public - apt-get update
- apt-get install -y graphviz
# - mkdir public
- cd docs ; make html - cd docs ; make html
# - mv _build/html/ ../public/ # - mv _build/html/ ../public/
dependencies: dependencies:
......
...@@ -14,6 +14,26 @@ help: ...@@ -14,6 +14,26 @@ help:
.PHONY: help Makefile .PHONY: help Makefile
# detect what shell is used
ifeq ($(findstring cmd.exe,$(SHELL)),cmd.exe)
$(info "shell Windows cmd.exe")
DEVNUL := NUL
WHICH := where
else
$(info "shell Bash")
DEVNUL := /dev/null
WHICH := which
endif
# detect platform independently if gcc is installed
ifeq ($(shell ${WHICH} dot 2>${DEVNUL}),)
$(error "dot is not in your system PATH. Please install it and put it into your PATH")
$(error "http://graphviz.org")
else
$(info "dot (graphviz) found")
endif
# Catch-all target: route all unknown targets to Sphinx using the new # Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile %: Makefile
......
@ECHO OFF @ECHO OFF
pushd %~dp0 pushd %~dp0
REM Command file for Sphinx documentation REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" ( if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build set SPHINXBUILD=sphinx-build
) )
set SOURCEDIR=. set SOURCEDIR=.
set BUILDDIR=_build set BUILDDIR=_build
set DOT=dot -V
if "%1" == "" goto help
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 ( %SPHINXBUILD% >NUL 2>NUL
echo. if errorlevel 9009 (
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx echo.
echo.installed, then set the SPHINXBUILD environment variable to point echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.to the full path of the 'sphinx-build' executable. Alternatively you echo.installed, then set the SPHINXBUILD environment variable to point
echo.may add the Sphinx directory to PATH. echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo. echo.may add the Sphinx directory to PATH.
echo.If you don't have Sphinx installed, grab it from echo.
echo.http://sphinx-doc.org/ echo.If you don't have Sphinx installed, grab it from
exit /b 1 echo.http://sphinx-doc.org/
) exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end %DOT% >NUL 2>NUL
if errorlevel 9009 (
:help echo.
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% echo.The 'dot' command was not found. Make sure you have Graphviz installed.
echo.
:end echo.If you don't have Graphviz installed, grab it from
popd echo.http://graphviz.org, install it and put it in the PATH.
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd
...@@ -25,7 +25,7 @@ class BaseVariable(ABC): ...@@ -25,7 +25,7 @@ class BaseVariable(ABC):
:param name: Name of the variable (optional) :param name: Name of the variable (optional)
:type name: str :type name: str
:raises: TypeError if :param:`name` is of wrong type :raises: TypeError if :attr:`name` is of wrong type
:rtype: None :rtype: None
""" """
self._value = None self._value = None
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment