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.

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

Support Sphinx2 #5064

Closed
humitos opened this issue Jan 3, 2019 · 9 comments
Closed

Support Sphinx2 #5064

humitos opened this issue Jan 3, 2019 · 9 comments
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required Priority: low Low priority Status: blocked Issue is blocked on another issue

Comments

@humitos
Copy link
Member

humitos commented Jan 3, 2019

Sphinx2 is doing a lot of incompatible changes that we should start considering into our roadmap to support it.

This is not an issue to start working now, but to consider that it will affect our platform in many ways and we should start thinking about it and noting down where the problems would be and what are the actions that we should take.

Related: #3581 (comment)

@humitos humitos added Improvement Minor improvement to code Needed: design decision A core team decision is required Priority: low Low priority Status: blocked Issue is blocked on another issue labels Jan 3, 2019
@stsewd
Copy link
Member

stsewd commented Jan 3, 2019

I have a PR from the extension side readthedocs/readthedocs-sphinx-ext#57

@stsewd
Copy link
Member

stsewd commented Jan 3, 2019

And we need #3581, well we only need that if we want to make sphinx 2.0 the default

@davidfischer
Copy link
Contributor

I don't think sphinx2 will be our default for quite some time.

@humitos
Copy link
Member Author

humitos commented May 13, 2019

FYI. Sphinx builder dirhtml in Sphinx 2.0+ uses the name dirhtml. I think RTD v2 config is using htmldir. I'm not sure if the two are mapping correctly.

(from #4638 (comment))

@stsewd
Copy link
Member

stsewd commented May 13, 2019

We map the builder from the config file to our custom builder, so if anything we should change our builder custom builder (if needed). Also maybe is a good idea to include dirhtml as option in the config file too?

@stsewd
Copy link
Member

stsewd commented Aug 27, 2019

Just for clarification, we use our custom builder (readthedocsdirhtml). htmldir was used because that's how all classes are called in our code. So, this is nothing blocking for sphinx 2.0 support :)

@stsewd
Copy link
Member

stsewd commented Apr 29, 2020

We already support sphinx2. Only the rtd theme is missing support for it.

@stsewd stsewd closed this as completed Apr 29, 2020
@nschloe
Copy link

nschloe commented Apr 30, 2020

@stsewd Could you please link the bug for the rtd theme?

@stsewd
Copy link
Member

stsewd commented Apr 30, 2020

@nschloe readthedocs/sphinx_rtd_theme#838

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required Priority: low Low priority Status: blocked Issue is blocked on another issue
Projects
None yet
Development

No branches or pull requests

4 participants