Skip to content

Add make.bat for Windows documentation builds#872

Open
ShlokBagwe wants to merge 5 commits into
pysal:mainfrom
ShlokBagwe:docs-add-make.bat
Open

Add make.bat for Windows documentation builds#872
ShlokBagwe wants to merge 5 commits into
pysal:mainfrom
ShlokBagwe:docs-add-make.bat

Conversation

@ShlokBagwe

Copy link
Copy Markdown
Contributor

Adds a Windows compatible make.bat script to build Sphinx documentation locally.

libpysal previously provided only a Makefile, requiring Windows contributors to manually call sphinx-build. Now, running make.bat html enables easy local Sphinx doc builds.

AI Disclosure:
AI was used for code clarification. All communications were written by the contributor.

@codecov

codecov Bot commented Feb 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.7%. Comparing base (95829c9) to head (90bb738).
⚠️ Report is 19 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##            main    #872     +/-   ##
=======================================
+ Coverage   85.6%   85.7%   +0.1%     
=======================================
  Files        151     151             
  Lines      16310   16330     +20     
=======================================
+ Hits       13967   14002     +35     
+ Misses      2343    2328     -15     

see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@martinfleis

Copy link
Copy Markdown
Member

Is there a reason this differs from the one generated by sphinx?

@ShlokBagwe

Copy link
Copy Markdown
Contributor Author

Actually this is a simplified version that mirrors the existing Makefile behavior, but it does differ slightly from the default Sphinx generated template.
If you say, I will replace it with the standard make.bat generated by Sphinx to improve the robustness and keep things consistent. Just let me know and I will update it

@martinfleis

Copy link
Copy Markdown
Member

If you say, I will replace it with the standard make.bat generated by Sphinx to improve the robustness and keep things consistent. Just let me know and I will update it.

I think that would be preferred. We don't want to maintain our own versions of these files.

@martinfleis martinfleis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@martinfleis

Copy link
Copy Markdown
Member

This part also needs to be included in here

libpysal/docs/Makefile

Lines 17 to 20 in e6bdd53

# Custom target to generate files
generate-rst:
@echo "Generating custom files..."
@python ../scripts/w_g_comparison.py

@martinfleis

Copy link
Copy Markdown
Member

Is there anyone with a Windows machine who could test this out?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants