Krystine Sherwin
9925b27432
Goodbye guidelines (except GettingStarted)
...
Drop the parts that are being dropped.
Move the things that are being moved.
Also move the verilog stuff out of README and into the docs.
GettingStarted is less cut and dry, so hold off on that one.
2024-12-05 09:21:12 +13:00
Krystine Sherwin
f0da1cc67f
Start removing guidelines folder
...
Disable the export to docs and remove any references to the guidelines folder.
2024-12-05 09:18:56 +13:00
KrystalDelusion
6f3376cbe6
Merge pull request #4730 from YosysHQ/krys/downstream-docs
...
Improvements for downstream-distro maintainability.
2024-11-28 14:35:16 +13:00
George Rennie
8148ebd1ad
docs: document that assigns must come before switches in case rules
2024-11-21 22:41:13 +01:00
Krystine Sherwin
e649c1a8e1
Docs: Accept empty string for release envvar
2024-11-20 12:31:12 +13:00
Krystine Sherwin
44b68fb498
Docs: Add check for envvar to disable todos
2024-11-20 12:18:17 +13:00
KrystalDelusion
22e214ec6d
Merge pull request #4705 from YosysHQ/docs-preview-lintonly
...
Emphasise that read_verilog doesn't lint
2024-11-19 03:57:01 +13:00
Krystine Sherwin
1476eaba00
Docs: Add fallback for missing furo_ys
...
This is mainly intended for (latex)pdf builds which do not use the furo-ys html theme, where the yosys script syntax highlighting can safely fallback to plaintext. This effectively makes `furo-ys` an optional dependency to simplify distro-package maintainability.
See also #4725 .
2024-11-12 16:23:12 +13:00
KrystalDelusion
4343c791cb
Merge pull request #4704 from YosysHQ/krys/drop_ilang
...
Remove references to ilang
2024-11-08 11:28:06 +13:00
Miodrag Milanovic
647d61dd92
Release version 0.47
2024-11-05 07:59:25 +01:00
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
ee73a91f44
Remove references to ilang
2024-11-05 12:36:31 +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