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

confusion of required arguments #162

Closed
Borda opened this issue May 15, 2024 · 3 comments
Closed

confusion of required arguments #162

Borda opened this issue May 15, 2024 · 3 comments
Labels

Comments

@Borda
Copy link
Contributor

Borda commented May 15, 2024

Hello, I would love to try this extension in Lightning-AI/torchmetrics#2518, but so far hitting some issues; the latest one with installing from master (lat release does not work with py3.9, #155 (comment))

Following the example in the readme, https://github.com/sphinx-doc/sphinx-autobuild#using-with-makefile, I get the following error:

make[1]: Entering directory '/home/jirka/Workingspace/pt-metrics/docs'
sphinx-autobuild "source" "build" -W 
usage: sphinx-autobuild [OPTIONS] SOURCEDIR OUTPUTDIR [FILENAMES...]
sphinx-autobuild: error: the following arguments are required: sourcedir, outputdir, filenames
make[1]: *** [Makefile:22: livehtml] Error 2

Based on the usage: sphinx-autobuild [OPTIONS] SOURCEDIR OUTPUTDIR [FILENAMES...] filenames are optional, but in fact, they are required or what am I missing?

@pradyunsg
Copy link
Collaborator

sphinx-autobuild "source" "build" -W

Does sphinx-autobuild -W "source" "build" work? (asking based on the help error's message, which indicates options need to before the positional arguments.

@Borda
Copy link
Contributor Author

Borda commented May 15, 2024

Does sphinx-autobuild -W "source" "build" work?

not really, getting this error:

metrics/docs$ sphinx-autobuild -W "source" "build"
usage: sphinx-autobuild [OPTIONS] SOURCEDIR OUTPUTDIR [FILENAMES...]
sphinx-autobuild: error: the following arguments are required: sourcedir, outputdir, filenames

return42 added a commit to return42/sphinx-autobuild that referenced this issue May 30, 2024
…rgv[1:]`

To reproduce the issue read comment [1].

[1] https://github.com/sphinx-doc/sphinx-autobuild/pull/160/files#r1620387971

Closes: sphinx-doc#162
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
@pradyunsg pradyunsg added the bug label May 30, 2024
@return42
Copy link
Contributor

return42 commented Sep 3, 2024

Should be closed by #164

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants