Skip to content

Commit

Permalink
Readthedocs7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Zuiderwi committed Nov 13, 2024
1 parent adffb25 commit 37832e0
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 1 deletion.
35 changes: 35 additions & 0 deletions docs/Make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

:end
popd
21 changes: 21 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@

# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This is the documentation for **KASGOLF**, a 1D `Deltares <https://www.deltares.

.. note::

Many version of LOCKGATE have been created and mentioned in literature [1], [2] en [3]. LOCKGATE 2 contains a set of codes that calculates the waveforces on a lock gate. Part of LOCKGATE 2 is the code KASGOLF, also refered to as LOCKGATE5 in [3].
Many version of LOCKGATE have been created and mentioned in literature [1], [2] en [3]. LOCKGATE 2 contains a set of codes that calculates the waveforces on a lock gate. Part of LOCKGATE 2 is the code KASGOLF, also refered to as 'LOCKGATE5' in [3].


##################
Expand Down

0 comments on commit 37832e0

Please sign in to comment.