Skip to content

Commit

Permalink
Fix #8298: sphinx-quickstart: Add :option:`sphinx-quickstart --no-sep…
Browse files Browse the repository at this point in the history
…` option
  • Loading branch information
tk0miya committed Oct 25, 2020
1 parent f2a3118 commit b453be7
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGES
Expand Up @@ -28,6 +28,7 @@ Features added
directory on build man page
* #8289: epub: Allow to suppress "duplicated ToC entry found" warnings from epub
builder using :confval:`suppress_warnings`.
* #8298: sphinx-quickstart: Add :option:`sphinx-quickstart --no-sep` option

Bugs fixed
----------
Expand Down
4 changes: 4 additions & 0 deletions doc/man/sphinx-quickstart.rst
Expand Up @@ -33,6 +33,10 @@ Options

If specified, separate source and build directories.

.. option:: --no-sep

If specified, create build directroy under source directroy.

.. option:: --dot=DOT

Inside the root directory, two more directories will be created;
Expand Down
4 changes: 3 additions & 1 deletion sphinx/cmd/quickstart.py
Expand Up @@ -489,8 +489,10 @@ def get_parser() -> argparse.ArgumentParser:
help=__('project root'))

group = parser.add_argument_group(__('Structure options'))
group.add_argument('--sep', action='store_true', default=None,
group.add_argument('--sep', action='store_true', dest='sep', default=None,
help=__('if specified, separate source and build dirs'))
group.add_argument('--no-sep', action='store_false', dest='sep',
help=__('if specified, create build dir under source dir'))
group.add_argument('--dot', metavar='DOT', default='_',
help=__('replacement for dot in _templates etc.'))

Expand Down

0 comments on commit b453be7

Please sign in to comment.