You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Updating this page in the docs made me realize that this part of the docs could really use a restructure:
This page is titled Sphinx Design but it also includes info about two other Sphinx extensions, sphinx-copybutton and sphinx-togglebutton, that have nothing to do with sphinx-design.
More confusingly, the next page in the docs, "Extending the theme" has a section about sphinx-togglebutton, as if that extension wasn't just discussed on the previous page.
This page is under: "User Guide / Content and features." The "Content and features" section has four pages, three of which are about other extensions that our theme is designed to work with. This makes me think that we should probably have a dedicated section on such extensions. And each page in that section should be dedicated to that particular extension (even if it means that some of those pages will be really short).
Opening this issue so we can discuss this organisation proposal as a team @drammock@12rambau@choldgraf and then @gabalafou and I can work on any changes
The text was updated successfully, but these errors were encountered:
I like the proposed restructuring. I'd recently noticed the same issue with the "sphinx design" page (but I failed to open an issue about it and promptly forgot). So I'm glad you noticed too and said something.
That makes sense to me as well - sounds like this is content that had grown organically and is now in need of some pruning and restructuring. I also think it's helpful to have one page per extension because then there is a source of truth to go to when trying to figure out if the theme is behaving "as expected" since it's often hard to test for theme-specific CSS without just looking at its effects for reference.
Updating this page in the docs made me realize that this part of the docs could really use a restructure:
Originally posted by @gabalafou in #1721 (comment)
Note
Opening this issue so we can discuss this organisation proposal as a team @drammock @12rambau @choldgraf and then @gabalafou and I can work on any changes
The text was updated successfully, but these errors were encountered: