github-actions[bot]
0d9c59e4e6
Bump version
2024-10-18 00:20:28 +00:00
Krystine Sherwin
f881ba6200
test-docs-build: Install docs prereqs
2024-10-18 05:38:49 +13:00
KrystalDelusion
38dae1d7e0
Merge pull request #4376 from YosysHQ/krys/docs_cmd_ref
...
Docs: Use formatted cmd ref in pdf
2024-10-18 04:53:43 +13:00
github-actions[bot]
a54f632258
Bump version
2024-10-17 00:20:44 +00:00
Krystine Sherwin
d1c6699125
test-docs-build: Use fast runner
2024-10-17 07:15:11 +13:00
Krystine Sherwin
e5da0e341e
Makefile: Combine gen_images and gen_examples
...
gen_images and gen_examples are never called on their own, CI scripts call make -C docs directly. Since calling them both in parallel seems to cause issues, let's not do that, and instead combine them into a singular `make docs/gen`. This should resolve the parallelism problems by making them sequential while still retaining the -j support.
2024-10-17 07:12:34 +13:00
Krystine Sherwin
5d14c3017e
test-build.yml: Add test-docs-build
...
Try use self hosted linux runner to build html and latexpdf to check for errors.
Trying to use the build artifact didn't seem to work, so just run it on its own.
Upload docs/build folder as artifact to enable review without having to build
locally. Note: doesn't include verific, so will differ slightly from final
published docs.
2024-10-17 06:10:12 +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
KrystalDelusion
f137509505
Merge pull request #4332 from YosysHQ/krys/help_docs
...
Add docs generation from cells help output
2024-10-17 05:01:35 +13:00
Krystine Sherwin
e9d9e92804
Docs: Make code_examples/extensions parallel safe
2024-10-17 04:40:21 +13:00
Martin Povišer
9432e972f7
Merge pull request #4626 from povik/select-t-at
...
select: Add new `t:@<name>` syntax
2024-10-16 10:18:05 +02:00
github-actions[bot]
11e94cc97c
Bump version
2024-10-16 00:20:45 +00:00
Emil J. Tywoniak
f9f509bc25
select: add t:@<name> test
2024-10-15 21:06:06 +02:00
Emil J. Tywoniak
81bbde62ca
verilog_parser: silence yynerrs warning
2024-10-15 08:32:55 -04:00
Martin Povišer
09be0351ce
select: Add new `t:@<name>` syntax
2024-10-15 12:22:02 +02:00
github-actions[bot]
adb6cdb167
Bump version
2024-10-15 00:20:48 +00: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
c93fd54e43
ci: Install docs/reqs (namely, furo-ys)
2024-10-15 11:37:52 +13:00
Krystine Sherwin
27b8b4e81e
Docs: Fix missing groups
...
$lut and $sop were missed in the rebase, and $buf is new to main since the last rebase.
2024-10-15 11:08:30 +13:00
Krystine Sherwin
1513366f21
Docs: Adding mux cell descriptions
...
Also making ver2 cell descriptions consistently spaced.
2024-10-15 07:37:34 +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
4d84d7e69f
simlib.v: Add x-output tag
...
Also a few extra cell help texts.
2024-10-15 07:35:41 +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
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
ed92374263
simlib.v: Update case equality operators to v2
...
Also tag as x-aware cells and add titles.
2024-10-15 07:35:41 +13:00
Krystine Sherwin
b1025dbaa6
cellhelp.py: Cells can have tags
...
Tags are added to the list of properties when exporting to `cells.json`.
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
596d914ead
simcells: Apply group tags
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
11d2cbced2
Docs: Don't delete source/cell on make clean
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
6aceb6a297
cmdref.py: Support autoref for 'help <cmd>'
2024-10-15 07:34:52 +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
04b0ae540d
cellref: Move default help message to register.cc
...
Drop the default help message from rst while still displaying it on the command line.
Fix command line formatting for older style help messages.
2024-10-15 07:31:47 +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