Skip to content

Commit

Permalink
add make capapility to Windows
Browse files Browse the repository at this point in the history
  • Loading branch information
cbielow committed Sep 2, 2024
1 parent d0ff635 commit 865acc2
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@ Once the environment is active, you can install all required python packages usi
pip install -r <pyOpenMS_dir>/docs/requirements.txt


To build the docs run

sphinx-build <pyOpenMS_dir>/docs/source/ build/

On a linux system, you can also use the provided Makefile and run
To build the docs run (works on all OS's)

make html

and check validity of links using

make linkcheck




37 changes: 37 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
if "%SPHINXOPTS%" == "" (
set SPHINXOPTS=-j auto
)
%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

0 comments on commit 865acc2

Please sign in to comment.