sphinx-doc / sphinx-doc/sphinx
Allow to specify a directory to include in html_static_path
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Currently one can specify a directory so that its contents are recursively included in html_static_path, or a specific file to be included. In some cases it would be useful to be able to specify a directory to be included (itself, not just its contents). As far as I can see, there is no way to do that at the moment.
This came up during the recent upgrade to mathjax 3 in sagemath: https://trac.sagemath.org/ticket/25833
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 by tracing how the html_static_path configuration is processed and how existing static files and directories are tested. Add a regression test covering inclusion of the directory itself, using the MathJax 3 upgrade context as an example, and verify the generated documentation contains the directory at the requested path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100