8 commits

Author	SHA1	Message	Date
Krystine Sherwin	024bfcdc53	Docs: Add :cmd:title: directive ... Calling :cmd:title:`<cmd>` will generate a cross reference to `<cmd>`, but unlike :cmd:ref: which displays a literal block and puts the title (short_help) in the hovertext (the title field of an a-ref), :cmd:title: will display "<cmd> - <short_help>" as plain text. Thus replacing the previous use case of referring to :doc:`cmd/<cmd>`. Also refactor util py scripts to have more descriptive names.	2025-03-21 10:26:12 +13:00
Krystine Sherwin	927dc445dd	Docs: Render cell titles ... Also put property lists *after* cell description.	2024-10-15 07:35:42 +13:00
Krystine Sherwin	ce6a7fe4fc	docs/util: Cells now have properties ... Properties are both an option: ``` .. cell:def:: $add :properties: is_evaluable ``` and a field: ``` .. cell:def:: $eqx :property x-aware: :property is_evaluable: ``` Properties as an option appear in the property index: linking a given property to all cells with that property; while properties as a field display with the cell.	2024-10-15 07:35:41 +13:00
Krystine Sherwin	b127ac07f8	Docs: Preliminary autocellgroup usage ... Remove `/source/cell` from .gitignore. Add a few initial cell pages. Add YosysCellGroup documenter and cell:group directive. Update Documenters to use nested json. Better nested tocs for group.module.source layout.	2024-10-15 07:26:04 +13:00
Krystine Sherwin	37573a6f00	Docs: Use json for cellref ... e.g. ``` .. autocell:: $alu :source: :linenos: ```	2024-10-15 07:26:04 +13:00
Krystine Sherwin	84f2968031	cellref: Better name checking ... Fix RTD not including source with warning `WARNING: invalid signature for autocellsource ('/home/docs/checkouts/readthedocs.org/user_builds/yosys/checkouts/manual-rewrite/source/generated/simlib.v:$alu::__source')`.	2024-10-15 07:24:14 +13:00
Krystine Sherwin	ccd3bace23	Docs: Add cells loc config value	2024-10-15 07:24:14 +13:00
Krystine Sherwin	e5f54dd7cd	Docs: Cell reference as a custom documenter ... Use autodocs to perform cell reference docs generation instead of generating rst files directly. e.g. ``` .. autocell:: simlib.v:$alu :source: :linenos: ```	2024-10-15 07:23:45 +13:00