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

Use sphinx-design for our {toggle} directive and eventually deprecate it #50

Open
choldgraf opened this issue Jul 14, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@choldgraf
Copy link
Member

choldgraf commented Jul 14, 2022

Context

Currently we use JavaScript to look for classes and convert objects with those classes into a toggle-able admonition or details block. This is what we use in MyST-NB to show/hide cells.

However, sphinx-design has its own dropdown directive that has more functionality and flexibility. It is unnecessary for us to maintain our own custom directive here as well as in Sphinx Design.

Proposal

I propose that we consider phasing out the direct use of the {toggle} directive here, by doing the following things:

  1. Make {toggle} re-use Sphinx Design by default
  2. Raise a warning suggesting that people use Sphinx Design instead
  3. Eventually deprecate the {toggle} directive.

Eventually we might even be able to deprecate this whole package if we can get the same functionality via sphinx-design and myst-nb.

Tasks and updates

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant