diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..d4bb2cbb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# 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 = . +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) diff --git a/docs/_static/virtual_ship_logo.png b/docs/_static/virtual_ship_logo.png index 23c68c32..3895ee39 100644 Binary files a/docs/_static/virtual_ship_logo.png and b/docs/_static/virtual_ship_logo.png differ diff --git a/docs/_static/virtual_ship_logo_inverted.png b/docs/_static/virtual_ship_logo_inverted.png index d3334a12..20662d1f 100644 Binary files a/docs/_static/virtual_ship_logo_inverted.png and b/docs/_static/virtual_ship_logo_inverted.png differ diff --git a/docs/_static/virtual_ship_logo_inverted_no_text.png b/docs/_static/virtual_ship_logo_inverted_no_text.png deleted file mode 100644 index 41ba70d6..00000000 Binary files a/docs/_static/virtual_ship_logo_inverted_no_text.png and /dev/null differ diff --git a/docs/_static/virtual_ship_logo_no_text.png b/docs/_static/virtual_ship_logo_no_text.png deleted file mode 100644 index d1910ee9..00000000 Binary files a/docs/_static/virtual_ship_logo_no_text.png and /dev/null differ diff --git a/docs/conf.py b/docs/conf.py index 85fbb484..05fd3adc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -32,9 +32,8 @@ html_theme_options = { "logo": { - "text": "Virtual Ship Parcels", - "image_light": "virtual_ship_logo_no_text.png", - "image_dark": "virtual_ship_logo_inverted_no_text.png", + "image_light": "virtual_ship_logo.png", + "image_dark": "virtual_ship_logo_inverted.png", }, "use_edit_page_button": True, "github_url": "https://github.com/OceanParcels/virtualship", diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..32bb2452 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +%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.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd