3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-07-26 22:17:55 +00:00
yosys/docs
Krystine Sherwin d88688781d
Docs: Skeleton documentation for writing command help
Use `chformal` as example, comparing the `autocmd` output with `ChformalPass::formal_help()`, the json dump from the `ContentListing`, the command line output, and the RST generated (using `autocmd_rst`).
Includes bullet points on each step for more information.
Should eventually end up in `yosys_internals/extending_yosys/contributing.rst`, but it currently lives in `cmd/index_internal.rst` to avoid merge conflicts since cell help documentation is still WIP.
Also exports chformal source and help output to `docs/source/generated` during `make docs/prep`.
2025-07-21 10:35:57 +12:00
..
source Docs: Skeleton documentation for writing command help 2025-07-21 10:35:57 +12:00
tests docs: Fix macro_commands 2024-05-10 09:51:37 +12:00
util autocmd_rst: autodoc for generated RST 2025-07-21 10:35:57 +12:00
.gitignore Docs: Group commands 2025-07-21 10:34:13 +12:00
Makefile Docs: Group commands 2025-07-21 10:34:13 +12:00