3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-06-06 06:03:23 +00:00
yosys/docs/source/cmd
Krystine Sherwin 753b418a8b
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-03-21 10:28:47 +13:00
..
index_backends.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_formal.rst cmdref: Assigning cmds to formal group 2025-03-21 10:26:12 +13:00
index_frontends.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_internal.rst Docs: Skeleton documentation for writing command help 2025-03-21 10:28:47 +13:00
index_kernel.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_other.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_passes.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_passes_cmds.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_passes_equiv.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_passes_fsm.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_passes_hierarchy.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_passes_memory.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_passes_opt.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_passes_pmgen.rst Docs: Group commands 2025-03-21 10:26:10 +13:00
index_passes_proc.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_passes_sat.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_passes_techmap.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_achronix.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_anlogic.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_common.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_coolrunner2.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_easic.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_ecp5.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_fabulous.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_gatemate.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_gowin.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_greenpak4.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_ice40.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_intel.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_intel_alm.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_lattice.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_microchip.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_nanoxplore.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_nexus.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_quicklogic.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_sf2.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00
index_techlibs_xilinx.rst Docs: Grouping changes 2025-03-21 10:26:12 +13:00