Switch RTD to use `dirhtml` builder
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.9k
- Forks
- 1.4k
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 1
Description
This would essentially make the online docs URLs nicer, dropping that .html pattern.
Example: See https://pip.pypa.io/en/stable/quickstart/ -- they have quickstart/ vs quickstart.html
The default is html and it can be switched easily via the config file: https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx-builder
I don't suggest changing anything in tox, though. It's useful for local previews to still rely on html.
Contributor guide
No contributing guide indexed for this repository
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
Inspect the repository's Read the Docs configuration and the existing tox setup. Change the online documentation builder to dirhtml while leaving tox on html, then verify that hosted pages use directory-style URLs and local previews still work as before.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100