diff --git a/docs/conf.py b/docs/conf.py index 9ab2f209..a7cb42f3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -113,9 +113,14 @@ # If true, keep warnings as "system message" paragraphs in the built documents. # keep_warnings = False +# --- Options for nbsphinx ----------------------------------------------- +# prevents cell run time taking too long nb_execution_timeout = 60 +# uses cached information nb_execution_mode = "cache" +# ensures there is not a conflict if user has multiple kernels +nbsphinx_kernel_name = 'python-upstream-dev' # -- Options for HTML output ---------------------------------------------- diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index dc1312ab..00000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -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