sphinx-quickstart: Multiple --suffix

Open Beginner friendly
#9,510 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Quiet
Tech stack
python
Domain
cli, documentation

Research direction

Start in sphinx/cmd/quickstart.py at the --suffix add_argument call around lines 501–502. Trace how the suffix is used for source_suffix and for determining generated document names. Done means multiple --suffix values are accepted, source_suffix receives the list, and the first value controls generated document suffixes.

Written by the indexing model from the issue text.

Description

type:enhancement

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

I would like to set up a project with both .rst and .md recognized as source file suffix. It can be achieved by editing conf.py after sphinx-quickstart run, but it is more convenient if sphinx-quickstart command supports this.

Describe the solution you'd like

Allow multiple --suffix by setting action="append" in add_argument call:
https://github.com/sphinx-doc/sphinx/blob/f59026865a8c658acbc6d5690c146f4be0851854/sphinx/cmd/quickstart.py#L501-L502

and use list as source_suffix value.

Additional context

When determining the generated documents' suffix, first --suffix value should be used.

Dominant language
Python
Stars
8k
Forks
2.6k
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from sphinx-doc/sphinx

All issues in sphinx-doc/sphinx

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.