sphinx-reload icon indicating copy to clipboard operation
sphinx-reload copied to clipboard

Can we fix `sphinx-reload` failing to render in "Git Bash on Windows"?

Open ycexiao opened this issue 5 months ago • 1 comments

Hi! Thanks for making sphinx-reload. We developed scikit-package(https://github.com/scikit-package/scikit-package) to help the scientific community build Python applications, and we want to encourage more people to use sphinx-reload in their workflow. But we've encountered a sphinx-reload rendering issue in Git Bash on Windows.

The following commands open a 404 web page and raise a FileNotFoundError: 'proj/doc/_build' not found.

cd proj/
sphinx-reload doc

This may be due to Windows using backslashes (\) as path separators, because sphinx-reload can correctly render the documentation page after I modified lines 100-101 insphinx_reload.py from:

if use_makefile:
    build_dir = self._sphinx.get_make_command(build_dir)

to:

if use_makefile:
    build_dir = build_dir.replace("\\", "/")
    build_dir = self._sphinx.get_make_command(build_dir)

Could you please look into this issue? I'm also happy to help. Your work can help many of our Windows users.

ycexiao avatar Jun 02 '25 23:06 ycexiao