Skip to content

Standardise make files #35

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

Merged
niksirbi merged 3 commits into from
Mar 25, 2026
Merged

Standardise make files #35

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
6c3de20
Add sg_execution_times.rst to clean target in Makefile
lochhh Mar 17, 2026
2ccb329
Allow chaining commands in make.bat
lochhh Mar 17, 2026
0d0b7b3
Use make in CI
niksirbi Mar 25, 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
2 changes: 2 additions & 0 deletions .github/workflows/docs_build_and_deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ jobs:
with:
python-version: "3.13"
use-requirements-txt: false
use-make: true
github-token: ${{ secrets.GITHUB_TOKEN }}

deploy_sphinx_docs:
Expand All @@ -45,3 +46,4 @@ jobs:
- uses: neuroinformatics-unit/actions/deploy_sphinx_docs@v2
with:
secret_input: ${{ secrets.GITHUB_TOKEN }}
use-make: true
1 change: 1 addition & 0 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ clean:
rm -rf $(BUILDDIR)
rm -rf $(SOURCEDIR)/api_generated
rm -rf $(SOURCEDIR)/auto_examples
rm -f $(SOURCEDIR)/sg_execution_times.rst

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
Expand Down
15 changes: 14 additions & 1 deletion docs/make.bat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,20 @@ if errorlevel 9009 (

if "%1" == "" goto help

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:process_targets
if "%1" == "clean" (
if exist "%BUILDDIR%" rmdir /s /q "%BUILDDIR%"
if exist "%SOURCEDIR%\api_generated" rmdir /s /q "%SOURCEDIR%\api_generated"
if exist "%SOURCEDIR%\auto_examples" rmdir /s /q "%SOURCEDIR%\auto_examples"
if exist "%SOURCEDIR%\sg_execution_times.rst" del /q "%SOURCEDIR%\sg_execution_times.rst"
) else (
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
if errorlevel 1 goto end
)

shift
if not "%1" == "" goto process_targets

goto end

:help
Expand Down
Loading