Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Build (Sphinx): don't override html_context by default #10293

Closed
stsewd opened this issue May 4, 2023 · 5 comments · Fixed by #10394
Closed

Build (Sphinx): don't override html_context by default #10293

stsewd opened this issue May 4, 2023 · 5 comments · Fixed by #10394
Assignees
@stsewd
Labels
Needed: design decision A core team decision is required

Comments

@stsewd
Copy link
Member

stsewd commented May 4, 2023

Currently, we have this under a feature flag, but I think this should be the expected behavior.

ref #10057
@stsewd stsewd added the Needed: design decision A core team decision is required label May 4, 2023
@stsewd stsewd mentioned this issue May 4, 2023
Closed
@humitos
Copy link
Member

humitos commented May 11, 2023

Do you have any concerns about enabling the feature flag for everybody? Are you thinking about some use cases that are gonna break?

@stsewd
Copy link
Member Author

stsewd commented May 11, 2023

Not really, but this could break some projects if users have some invalid values set and were relying on rtd to "fix" them, but that's the same result they would get if they build their docs locally.

@humitos
Copy link
Member

humitos commented May 11, 2023

Gotcha. In that case, I'm 👍🏼 on moving forward with this. I'll add it to the roadmap so we can prioritize it.

@github-project-automation github-project-automation bot moved this to Planned in 📍Roadmap May 11, 2023
@stsewd
Copy link
Member Author

stsewd commented May 25, 2023

We have enabled this for all projects on the community version of RTD (readthedocs.org).

@stsewd stsewd moved this from Planned to In progress in 📍Roadmap May 25, 2023
@stsewd
Copy link
Member Author

stsewd commented Jun 6, 2023

We have enabled this for all projects on Read the Docs for Business (readthedocs.com)

stsewd added a commit that referenced this issue Jun 6, 2023
@stsewd
Sphinx: don't override html_context by default
d59be69 
We have this feature enabled on .org and .com,
we haven't heard any complaints.

Closes #10293
@stsewd stsewd mentioned this issue Jun 6, 2023
Merged
stsewd added a commit that referenced this issue Jun 6, 2023
@stsewd
Sphinx: don't override html_context by default (#10394)
542115d 
We have this feature enabled on .org and .com,
we haven't heard any complaints.

Closes #10293
@github-project-automation github-project-automation bot moved this from In progress to Done in 📍Roadmap Jun 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stsewd stsewd

Labels
Needed: design decision A core team decision is required
Projects
📍Roadmap
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Sphinx: don't override html_context by default readthedocs/readthedocs.org
3 participants
@humitos @stsewd and others