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

Exposing more than just sphinx-build to python -m sphinx #11656

Closed
jamesbraza opened this issue Aug 29, 2023 · 2 comments
Closed

Exposing more than just sphinx-build to python -m sphinx #11656

jamesbraza opened this issue Aug 29, 2023 · 2 comments

Comments

@jamesbraza
Copy link
Contributor

Is your feature request related to a problem? Please describe.

Running python -m sphinx --help, I see it's an alias for sphinx-build.

It would be cool if this was an entrypoint to other commands, like sphinx-apidoc.

Describe the solution you'd like

A more generalized console entrypoint that supports other commands:

python -m sphinx --help
# Tells about build, apidoc, etc.
python -m sphinx build ...
python -m sphinx apidoc ...

Describe alternatives you've considered

A workaround is directly invoking the relevant modules as listed here:

python -m sphinx.cmd.build ...
python -m sphinx.ext.apidoc ...
@AA-Turner
Copy link
Member

See #5618, #6938; #10877 -- this is absolutely a goal, but mainly stuck on not having enough time. I did add -m sphinx build in 7.2 as preparation for this, though.

A

@jamesbraza
Copy link
Contributor Author

I was sure this had been already requested, but my searching didn't yield any duplicate issues. Thanks for linking them! And your work with Sphinx is appreciated!

Feel free to close this out as a duplicate if desired 👌.

@AA-Turner AA-Turner closed this as not planned Won't fix, can't repro, duplicate, stale Aug 30, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 30, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants