Replies: 2 comments
-
Right now and based on maintenance/support/compatibility it makes sense to at least consider making I am not sure about all the doc deps as there are a lot and we do not seem to treat them all equally regarding level of effort put to make them align with the look and behavior one expect throughout PST. |
Beta Was this translation helpful? Give feedback.
-
The main reason why I think Sphinx is better than mkdocs is its modularity, I can change anything. making an extention compulsory, not only means that you force it into your dependencies but also that you force it into the extention list without the user noticing it. Some extentions are conflicting with one another so doing this will prevent existing documentation to move to PST (sphinx-desing VS sphinx-tab, sphinx-image and sphinx-video, myst, myst_nb VS nbsphinx) I think it would be more complicated to enforce extentions rather than continue what is currently done. I agree that we use them in our documentation and some users are surprised but a simple note in our documentation would make it super clear. "if you want the same extentions as the one shown in our documentation, copy/paste our extension list.....". Alternatively we could create a PST CLI that creates the docs folder and all its content for people starting their documentation from scratch and they would get all our favorite tools. |
Beta Was this translation helpful? Give feedback.
-
Every optional extension we support is extra maintenance burden as we need to make sure PST works properly with and without the extension.
There is also a confusing things for users as when they visit our docs they are likely to assume that all the component they see belong to PST.
(Note: this is a different discussion than pinning)
I think that we should likely move many of the doc optional dependencies to mandatory, and do not support not having those extensions installed/enabled.
Beta Was this translation helpful? Give feedback.
All reactions