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

13 commits

Author SHA1 Message Date
Krystine Sherwin
39e3e39241
documenting.rst: Our custom Sphinx domains 2025-11-22 15:36:59 +13:00
Krystine Sherwin
dc8198561a
documenting.rst: Using autodoc
Switch `autocmd` to use the `seealso` admonition for referencing source file location instead of `note`.
2025-11-22 12:56:30 +13:00
Krystine Sherwin
56c1ef2679
documenting.rst: Finished cells and starting on Sphinx
Use an external file to demonstrate the `autoref` role (the external file lets us `literalinclude` and `include` without writing out the source twice, while still showing all the different ways of using our custom roles).
2025-11-21 17:52:54 +13:00
Krystine Sherwin
da65409d69
documenting.rst: Cell help v1 and v2
Also a (commented) mention of v2a for the extra curious.
2025-11-21 12:30:54 +13:00
Krystine Sherwin
bb8ef02e85
docs: Intro to cell help
Allow autoref to render `help *` as yoscrypt instead of trying to link when `*` starts with `<` or `-`, as in `help <command>` and `help -all`.
Fix autoref `help *` being linkable when there is a line break in the middle.
2025-11-19 14:29:13 +13:00
Krystine Sherwin
784c73ad38
documenting.rst: Warning flags
Add `test_generic.cc` to docs gen, and rename `docs/gen/chformal` to the more generic `docs/gen/raw_commands` (in line with `docs/gen/raw_cells`).
2025-11-18 15:33:13 +13:00
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