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

No way to specify --no-sep in sphinx-quickstart #8298

Closed
webknjaz opened this issue Oct 6, 2020 · 1 comment
Closed

No way to specify --no-sep in sphinx-quickstart #8298

webknjaz opened this issue Oct 6, 2020 · 1 comment
Labels
api:cmdline type:proposal a feature suggestion
Milestone

Comments

@webknjaz
Copy link
Contributor

webknjaz commented Oct 6, 2020

Describe the bug

You can pre-fill project generation question answers when you run something like python -m sphinx.cmd.quickstart. For example, for omitting Makefile, you'd just specify --no-makefile.

But for --sep it does not work like that and it needs to be fixed.

To Reproduce

This happens without the arg:

$ python -m sphinx.cmd.quickstart
[...]
> Separate source and build directories (y/n) [n]:

This

$ python -m sphinx.cmd.quickstart --sep

chooses "y" automatically.

And there's no way to choose "n" automatically.

Expected behavior

Have --no-sep disabling dir separation.

Your project

N/A

Screenshots

N/A
Environment info

N/A

Additional context

N/A

@andres-fr
Copy link

+1! A quick workaround would be something like (untested):

import sphinx.cmd.quickstart as sphinx_quickstart
quickstart_argv = ["-q", "-p", PACKAGE_NAME, "-a", AUTHOR,
                   "--ext-autodoc", "--ext-imgmath", "--ext-viewcode",
                   "--ext-githubpages", "-d", "version="+VERSION,
                   "-d", "release="+VERSION, OUT_DIR]
sphinx_quickstart.main(argv=quickstart_argv)

@tk0miya tk0miya added api:cmdline type:proposal a feature suggestion and removed type:bug labels Oct 25, 2020
@tk0miya tk0miya added this to the 3.3.0 milestone Oct 25, 2020
tk0miya added a commit that referenced this issue Oct 27, 2020
Fix #8298: sphinx-quickstart: Add `sphinx-quickstart --no-sep` option
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api:cmdline type:proposal a feature suggestion
Projects
None yet
Development

No branches or pull requests

3 participants