Krystine Sherwin
e4994554fd
Docs: Fix nested list
2024-11-05 13:48:48 +13:00
Krystine Sherwin
b14a651142
Docs: Mention verilator for linting
...
Link to verilator in the introduction.
Include `verilator --lint-only fifo.v` in the example synth doc.
Fix linter warnings in fifo.v.
2024-11-05 13:29:45 +13:00
Krystine Sherwin
4ea6119734
cmdref: Move html only section inside cmd:def
...
Fixes missing links in body and `??` in tag/command index.
Update synth.rst to match.
2024-10-17 06:06:57 +13:00
Krystine Sherwin
e9d9e92804
Docs: Make code_examples/extensions parallel safe
2024-10-17 04:40:21 +13:00
Krystine Sherwin
bc77575c22
Docs: Fix word_logic.rst
...
It somehow got lost in the rebase.
2024-10-15 11:46:21 +13:00
Krystine Sherwin
dfe803b5c6
Docs: Comments from @jix
...
- Unswap shift/shiftx
- Add brief overview to cell lib
- Clarify $div cell B input
- Clarify unary operators
- What is $modfloor
2024-10-15 07:37:20 +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
7216f07691
Docs: Define is_evaluable
2024-10-15 07:35:41 +13:00
Krystine Sherwin
9d808caba6
Docs: Add note on $check
2024-10-15 07:35:41 +13:00
Krystine Sherwin
e40134c856
Docs: Update for properties
...
Add properties page, move cell_gate and cell_word under a singular cell_index along with properties. Fix links accordingly.
Also drop x-aware and x-output todos since they are resolved.
2024-10-15 07:35:41 +13:00
Krystine Sherwin
e3d939b719
Docs: Drop fifo.out and fifo.stat
...
These two files can now be safely .gitignore'd.
2024-10-15 07:35:41 +13:00
Krystine Sherwin
1a2401816a
Docs: Add cell title TODO
2024-10-15 07:35:41 +13:00
Krystine Sherwin
9ce6952131
Docs: TODOs block, todos don't
2024-10-15 07:35:41 +13:00
Krystine Sherwin
f70a66f5b3
Docs: Assert cell has group
...
Explicitly assign $_TBUF_ to `gate_other` and remove catch if a cell has no group.
2024-10-15 07:35:40 +13:00
Krystine Sherwin
5c4f7b4deb
Docs: $eqx aka case equality
2024-10-15 07:35:40 +13:00
Krystine Sherwin
217c2a15dd
Docs: Add todos from JF
2024-10-15 07:35:40 +13:00
Krystine Sherwin
00050833ef
Docs: Add gate_other page
...
Drop word_other block since it raises a warning, which will cause the RTDs build to fail.
2024-10-15 07:35:40 +13:00
Krystine Sherwin
5473b60aec
Docs: Split gate-level cells into subpages
2024-10-15 07:35:40 +13:00
Krystine Sherwin
b0bc29e215
Docs: Add todo for $check
2024-10-15 07:35:40 +13:00
Krystine Sherwin
78b9dbd4ea
Docs: Assign remaining word cells to groups
...
Move todos to correct place.
Add todo for x-prop cells.
2024-10-15 07:35:40 +13:00
Krystine Sherwin
c6414e08eb
Docs: Switch to furo-ys for YoscryptLexer
2024-10-15 07:34:53 +13:00
Krystine Sherwin
e78841ba45
Docs: Fix invalid autorefs
2024-10-15 07:34:53 +13:00
Krystine Sherwin
be5572ca0e
Docs: Less leading backslashes
2024-10-15 07:34:52 +13:00
Krystine Sherwin
2b4a4cb536
Docs: Fix fsm.rst
...
`$mux-tree` should be `$mux`-tree.
2024-10-15 07:34:52 +13:00
Krystine Sherwin
46580cebb3
Docs: Move rtlil_text (back) to appendix
2024-10-15 07:34:52 +13:00
Krystine Sherwin
1374fc2e2b
cellref: Deprecate cell_library.rst
...
Most of the word/coarse level cells have an assigned group and individual page.
The gate/fine level cells are all on one page.
Fix links to `cell_library.rst`.
2024-10-15 07:34:52 +13:00
Krystine Sherwin
c662529316
Docs: Move binary operators to cell appendix
...
Add binary group tag to relevant cells.
Remove content from `cell_library.rst` that is already moved.
2024-10-15 07:31:47 +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
5a4a4191af
Docs: Update conf.py for cellref
2024-10-15 07:26:04 +13:00
Krystine Sherwin
65723200e5
Docs: Delete unused cell_ref.rst
2024-10-15 07:26:04 +13:00
Krystine Sherwin
a119d41303
Docs: Move appendix toc to main toc
...
Adds an Appendix header to sidebar toc instead of being an (empty) subpage.
2024-10-15 07:25:27 +13:00
Krystine Sherwin
7eb33f1933
Docs: Testing autocell
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
1b0d8633c4
Docs: Add root to ToC
2024-10-15 07:24:14 +13:00
Krystine Sherwin
a66e94c5da
Docs: Switch to furo-ys
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
40ba92e956
Docs: Reflow line length
2024-10-15 07:23:45 +13:00
Krystine Sherwin
829e02ec5b
Docs: Shorten cmd:ref
2024-10-15 07:22:04 +13:00
Krystine Sherwin
e4ec3717bc
Docs: Update internal cells to autoref
2024-10-15 07:18:28 +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
d629aa6bf1
cellhelp: Split gate-level and word-level cells
2024-10-15 07:17:35 +13:00
Krystine Sherwin
a6641da73c
Docs: Initial version of cell_ref autogen
2024-10-15 07:16:39 +13:00
Miodrag Milanovic
e97731b9dd
Release version 0.46
2024-10-09 08:08:00 +02:00
Krystine Sherwin
edf29e725e
Docs: Add functional_ir to index
2024-10-07 22:20:22 +13:00
Krystine Sherwin
13d7b5fd6a
Docs: Ignore example outputs
2024-10-07 22:01:56 +13:00
Krystine Sherwin
0b1b94d85e
Docs: Clean example outputs
2024-10-07 22:00:28 +13:00
Krystine Sherwin
468a019c30
docs: Makefile tidying
...
examples and dots are now orthogonal.
2024-10-07 21:56:23 +13:00
TG
5841b44543
docs: Simplify images generation to allow parallel build
...
- remove the tidy target from the main target.
* aux/log file are already excluded in a .gititgnore file
* allow parallel generation as the tidy target imposes sequential build
2024-10-06 08:38:16 +02:00
Miodrag Milanović
b20df72e1e
Merge pull request #4536 from YosysHQ/functional
...
Functional Backend
2024-09-06 10:05:04 +02:00
Emily Schmidt
7de8be1451
functional_ir.rst: fix typo, document SExprWriter::flush
2024-09-03 14:30:56 +01:00