Convert HTML to reST with sphinx-design #96
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Using
sphinx-design
's grid, tabs, and cards, we can replicate most of our brochure site using reST instead of HTML. This allows us to drop a lot of custom CSS, some JavaScript, and most importantly, allows wiring up the build for translations.This is not a perfect translation, perhaps 90% of the way there. Notable differences are:
max-width
containers. That makes us use the default, which is a bit narrower, but probably not enough to matter. The other major difference is that the coloured rules are only the width of the content, instead of the full page. I don't think that there's any way to make them overflow easily.sphinx-design
cannot have any reST headings, so the HTML doesn't have headings, onlydiv
that are styled like them; this is a bit annoying from a semantic point of view, and possibly broken for accessibility. I'm not sure if this is somethingsphinx-design
can fix or if it's inherent to reST.sphinx-design
generates, but maybe it's something that could be implemented on their side.pydata-sphinx-theme
).Along those lines, I had some ideas of possible tweaks: