Skip to content
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

make.bat template jumps to help block without first checking if sphinx is installed #10122

Closed
AhiyaHiya opened this issue Jan 19, 2022 · 0 comments

Comments

@AhiyaHiya
Copy link

Describe the bug

If you were to invoke make.bat, before installing sphinx, you would get the following error:

'sphinx-build' is not recognized as an internal or external command,
operable program or batch file.

The reason why the above error is emitted and not the echo.The 'sphinx-build' command was not found. Make sure you have Sphinx[...] message is because if "%1" == "" goto help is called before checking if the app is installed.

This error is at line 13, in file sphinx/sphinx/templates/quickstart/make.bat.new_t.

Line 13 should be moved to after the app check, if errorlevel 9009 ([...]).

How to Reproduce

As an end user, I receive a folder with sphinx generated files, e.g. make.bat, conf.py, Makefile, and attempt to run make by calling make.bat

Expected behavior

Error message stating that I should install sphinx

Your project

NA

Screenshots

No response

OS

Win

Python version

3.8.7

Sphinx version

NA

Sphinx extensions

No response

Extra tools

No response

Additional context

No response

@tk0miya tk0miya added this to the 4.5.0 milestone Jan 23, 2022
tk0miya added a commit that referenced this issue Jan 30, 2022
Fix #10122: make.bat should check the installation before help
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants