Skip to content

Tweak docs build #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ericpre wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Tweak docs build #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1bb3f16
Fix building documentation on windows
ericpre May 6, 2026
a2950e2
Add rst files generated during docs build
ericpre May 6, 2026
3ee7c1b
Remove generated `rst` files during docs build when calling `make cle…
ericpre May 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,15 @@ htmlcov/

# Sphinx build output
docs/_build/
docs/api/generated/
docs/auto_examples/
docs/sg_execution_times.rst
build/html/
build/doctrees/

# Generated Pyodide wheel (built by workflow / make html — never commit)
docs/_static/wheels/
docs/_static/anywidget_config.js

# Editor / IDE
.idea/
Expand All @@ -41,5 +45,3 @@ docs/_static/wheels/

# macOS
.DS_Store


5 changes: 5 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,8 @@ help:
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

clean:
rm -rf $(BUILDDIR)/*
rm -rf docs/auto_examples/
rm -rf docs/api/generated/
11 changes: 10 additions & 1 deletion make.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set SOURCEDIR=docs
set BUILDDIR=build

%SPHINXBUILD% >NUL 2>NUL
Expand All @@ -23,6 +23,15 @@ if errorlevel 9009 (
exit /b 1
)

if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
rmdir /q /s docs\api\generated
rmdir /q /s docs\auto_examples
goto end
)


if "%1" == "" goto help

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
Expand Down