mirrors/yosys
3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-06-24 23:03:42 +00:00
Code Activity

cmdref: codeblock language now works

Browse source 
Add `options` map for setting `ContentListing` options with key:val pairs; currently only used with `ContentListing::codeblock()` language arg.
Fix generated codeblock rst to print each line of code with indentation, and change it to use explicit an `code-block` so we can set a language on it.
This commit is contained in:
Krystine Sherwin 2025-03-21 10:28:48 +13:00
parent fb944ca0fb
commit b1c9097a12
No known key found for this signature in database
4 changed files with 17 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/source/cmd/index_internal.rst
View file

@ -47,7 +47,8 @@ The ``formatted_help()`` method
added automatically
* ``codeblock`` content is displayed verbatim, use line breaks as desired;
takes an optional ``language`` argument for assigning the language in RST
output for code syntax highlighting (currently not implemented)
output for code syntax highlighting (use ``yoscrypt`` for yosys script
syntax highlighting)
* ``option`` lists a single option for the command, usually starting with a
dash (``-``); takes an optional second argument which adds a paragraph
node as a means of description
@ -62,8 +63,6 @@ The ``formatted_help()`` method
+ paragraphs are treated as raw RST, allowing for inline formatting and
references as if it were written in the RST file itself
.. todo:: Support ``ContentListing::codeblock`` language argument
.. todo:: Support anonymous optiongroup
If an option is added to the root node it should add the option to the last