sphinx-doc / sphinx

The Sphinx documentation generator
https://www.sphinx-doc.org/
Other
6.19k stars 2.03k forks source link

make html not working #12482

Open DarureTej opened 1 week ago

DarureTej commented 1 week ago

Describe the bug

I was able to create all the rst files, changed the conf file, added modules in index file . But when I do .\make.bat html nothing happens. Doesn't give any error or produces any file in build. I am vscode 1.90, python 3.11. image

How to Reproduce

image

Environment Information

vscode 1.90, python 3.11. terminal: window powershell

Sphinx extensions

No response

Additional context

No response

electric-coder commented 1 week ago

I advise not using PowerShell terminal. Try CMD as that's what make.bat was originally written for. There has been a pull request to convert the makefile to a PowerShell script but the PR was never completed.

Also, those error messages should be posted as text so they can be found using search, just posting screenshots stops future readers from finding this thread. I think triagers should close this issue for that reason alone, see Why should I not upload images of code/data/errors?

jayaddison commented 1 week ago

@DarureTej if using PowerShell, could you try running:

> Set-Item env:SPHINXOPTS "-D language=de"
> .\make.bat html

We mention the Set-Item step for PowerShell in some of our 'advanced usage' documentation, but not elsewhere as far as I can tell. That might be something we can improve.

jayaddison commented 1 week ago

In rapid hindsight: that probably shouldn't make a difference at all - there should be a default language configuration, so Set-Item shouldn't be needed.

jayaddison commented 1 week ago

Unfortunately I don't have access to a system with PowerShell on it at the moment, so my ability to help here may be limited. One thing that I would be curious about is what kind of output running the sphinx-build command from the shell (without any arguments) does.