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

Add a list of all available directives #607

Open
choldgraf opened this issue May 19, 2020 · 1 comment
Open

Add a list of all available directives #607

choldgraf opened this issue May 19, 2020 · 1 comment
Labels
documentation Something related to the documentation enhancement New feature or request

Comments

@choldgraf
Copy link
Member

choldgraf commented May 19, 2020

From executablebooks/MyST-Parser#81 @nathancarter brought up a good point that right now it can be confusing to authors exactly what directives they have available. @chrisjsewell mentioned that we might be able to auto-generate a list that Jupyter Book has by default:

I did something like this in https://github.com/chrisjsewell/rst-language-server and have used the result from that to populate the test fixtures in: https://github.com/executablebooks/MyST-Parser/tree/master/tests/test_renderers/fixtures (e.g. sphinx_directives.md, docutils_directives.md), and also to generate the auto-completes in https://marketplace.visualstudio.com/items?itemName=ExecutableBookProject.myst-highlight.

This issue is to track this docs improvement

@choldgraf choldgraf added documentation Something related to the documentation enhancement New feature or request labels May 19, 2020
@chrisjsewell chrisjsewell added this to To do in Documentation May 24, 2020
@chrisjsewell
Copy link
Member

This will now be achieved in https://github.com/executablebooks/sphinx-ext-autodoc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something related to the documentation enhancement New feature or request
Projects
Documentation
  
To do
Development

No branches or pull requests

2 participants