sphinx-doc / sphinx-doc/sphinx
sphinx-quickstart: Multiple --suffix
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 76/100