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

document the theme_result extension #323

Open
2bndy5 opened this issue Feb 7, 2024 · 0 comments · May be fixed by #343
Open

document the theme_result extension #323

2bndy5 opened this issue Feb 7, 2024 · 0 comments · May be fixed by #343
Labels
documentation Improvements or additions to documentation

Comments

@2bndy5
Copy link
Collaborator

2bndy5 commented Feb 7, 2024

I should document the rst-example directive (& its myst-example alias for .md doc sources).

I keep seeing possible use cases for this directive in user projects/examples. But there is no documentation to make users aware that the sphinx_immaterial.theme_result extension exists and what it provides.

For those passing by, the rst-example directive works by taking RST code as content and rendering an RST code block followed by a rendition of the RST code using the given sphinx builder (HTML-based is preferred/tested). This is used liberally throughout our docs and avoids the common copy-and-paste that doc authors would normally have to do to achieve a similar result.

@2bndy5 2bndy5 added the documentation Improvements or additions to documentation label Feb 7, 2024
2bndy5 added a commit that referenced this issue Apr 13, 2024
@2bndy5 2bndy5 linked a pull request Apr 13, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant