pydata-sphinx-theme icon indicating copy to clipboard operation
pydata-sphinx-theme copied to clipboard

DOC - Extensions documentation structure needs improvement

Open trallard opened this issue 4 months ago • 2 comments

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).

Originally posted by @gabalafou in https://github.com/pydata/pydata-sphinx-theme/pull/1721#discussion_r1493108853

[!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

trallard avatar Feb 23 '24 12:02 trallard