-
Notifications
You must be signed in to change notification settings - Fork 57
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
tab-set-code produces warning for code-block #79
Comments
Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗 |
It looks like this is the relevant check: sphinx-design/sphinx_design/tabs.py Lines 143 to 150 in a060931
However, the Sphinx |
Seems like this was actually due to me using an incorrectly escaped character - I'm closing this issue as this seems to work correctly. Apologies! |
Describe the bug
context
When I use
.. code-block::
directives inside of.. tab-set-code::
expectation
I expected the docs to build without warning or error.
bug
But instead I get a warning when running
make html
:WARNING: All children of a 'tab-code-set' should be a 'literal_block' [design.tab_code]
$ make html
problem
This is a problem because according to the documentation,
.. tab-set-code::
should work with.. code-block::
directives, and the (apparently unnecessary) warning is confusing.Reproduce the bug
In a RST file, include the following:
run
make html
This gives me the aforementioned warning.
If instead I use:
I don't get the warning
List your environment
sphinx 5.0.2
pydata-sphinx-theme 0.9.0
sphinx-design 0.2.0
Python 3.10.5
Linux-5.13.0-52-generic-x86_64-with-glibc2.31
The text was updated successfully, but these errors were encountered: