Skip to content

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

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.

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
ycexiao opened this issue Jun 2, 2025 · 0 comments
Open

Comments

@ycexiao
Copy link

ycexiao commented Jun 2, 2025

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.

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

No branches or pull requests

1 participant