sphinx-doc / sphinx-doc/sphinx
[docs] clarifications on usage of html_context
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
My html-only extension adds css. I ran into an issue where a user was missing the css from my extension because in their conf.py they were setting html_context['css_files'].
After finally finding #2442 I realized that they just need to set html_css_files instead. I want to add a documentation pull request with a note on html_context linking to the right configuration values for css and javascript. Before doing so, though
- What are the valid use cases of
html_context? I think it would be good to be a little more explicit in this PR with examples of what this variable should be used for (since I'm going to be saying what it should not be used for). - Which branch do I submit a docs PR to. Just to
master?
Thanks :)
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 locating the documentation for html_context and the html_css_files and JavaScript configuration values. Clarify valid html_context use cases, link to the relevant CSS and JavaScript settings, and confirm the appropriate branch for the documentation change.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- css, javascript, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100