Skip to content

Commit

Permalink
debugging publish tweaks (#1153)
Browse files Browse the repository at this point in the history
  • Loading branch information
sbillinge authored Jul 20, 2024
1 parent 41ec2cd commit 635d8bf
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 4 deletions.
2 changes: 1 addition & 1 deletion doc/source/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
BUILDDIR = build
BASENAME = $(subst .,,$(subst $() $(),,regolith))
RELEASE = v0.1

Expand Down
4 changes: 2 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@
html_domain_indices = False

# If false, no index is generated.
html_use_index = False
html_use_index = True

# If true, the index is split into individual pages for each letter.
html_split_index = False
Expand All @@ -194,7 +194,7 @@
html_show_sourcelink = False

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
html_show_sphinx = False
html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
# html_show_copyright = True
Expand Down
25 changes: 24 additions & 1 deletion doc/source/make.bat
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=_build
set SOURCEDIR=source
set BUILDDIR=build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
set I18NSPHINXOPTS=%SPHINXOPTS% .
if NOT "%PAPER%" == "" (
Expand All @@ -15,6 +18,19 @@ if NOT "%PAPER%" == "" (

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
)

if "%1" == "help" (
:help
echo.Please use `make ^<target^>` where ^<target^> is one of
Expand Down Expand Up @@ -187,4 +203,11 @@ results in %BUILDDIR%/doctest/output.txt.
goto end
)

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

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

:end
popd

0 comments on commit 635d8bf

Please sign in to comment.