Krystine Sherwin
c6414e08eb
Docs: Switch to furo-ys for YoscryptLexer
2024-10-15 07:34:53 +13:00
Krystine Sherwin
6aceb6a297
cmdref.py: Support autoref for 'help <cmd>'
2024-10-15 07:34:52 +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
Krystine Sherwin
c0f9828b3c
Docs: Add autoref role
...
Use new `autoref` role when using single backticks. Allows automatic mapping to a cmd ref or a cell ref.
2024-10-15 07:17:36 +13:00
Krystine Sherwin
f9b4e04fef
Docs: Add cell reference
...
Subclass the command reference code in order to support smart references to the internal cells.
2024-10-15 07:17:36 +13:00
Krystine Sherwin
e2c0f8fc50
Some tidy up
2023-08-14 12:13:29 +12:00
Krystine Sherwin
f8333e52f7
cmd links use title text
2023-08-08 12:19:13 +12:00
Krystine Sherwin
8203a01ba9
Adding custom domain for cmdref
2023-08-08 11:51:57 +12:00
KrystalDelusion
a14dec79eb
Rst docs conversion ( #3496 )
...
Rst docs conversion
2022-11-15 12:55:22 +01:00
