3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-11-24 06:31:28 +00:00
Commit graph

7 commits

Author SHA1 Message Date
Krystine Sherwin
657b0bd92b
documenting.rst: literalinclude cell doc examples
Add a sed command to the (top level) makefile for extract comment block for the specified cell.  Works with both simlib.v and simcells.v (by abusing `%` pattern matching slightly to disambiguate which to search).
2025-11-18 12:20:33 +13:00
Krystine Sherwin
4eff547f6f
documenting.rst: Dumping to JSON
Split into cmd/cell sections.  cmd json is in paragraphs, cell json is bullet points (and pending example).
Add (bullet point) section for warning flags.
Add note to `Pass::help()` about how each line should be a single `log()` call.
2025-11-17 18:49:07 +13:00
Krystine Sherwin
e5b9401bf3
documenting.rst: Command line rendering 2025-11-17 12:44:41 +13:00
Krystine Sherwin
966f52e123
documenting.rst: More json/sphinx bullets
Also moved them to the bottom, instead of being under the "command help" heading.
Now includes more info about cells, and the custom sphinx domains/directives/roles we have.
2025-11-15 16:06:09 +13:00
Krystine Sherwin
0a6ce3d820
documenting.rst: formatted_help 2025-11-15 11:54:42 +13:00
Krystine Sherwin
1186ca8f68
documenting.rst: WIP paragraphs
First couple sections done, plus a couple formatting tidy ups later on.
2025-11-14 18:10:34 +13:00
Krystine Sherwin
2da7627491
docs: Move help guides to documenting.rst 2025-11-14 14:21:59 +13:00