riscv
/
yosys
mirror of https://github.com/YosysHQ/yosys.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
14,197 Commits 92 Branches 49 Tags 38 MiB
Commit Graph

207 Commits

Author SHA1 Message Date
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 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 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 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 d629aa6bf1
cellhelp: Split gate-level and word-level cells 2024-10-15 07:17:35 +13:00
Krystine Sherwin 1a4ada40fe
Docs: Add cell gen to makefile 
Generate in a temp directory and use `rsync -rc` to only update rst files that have changed.  This prevents sphinx from having to re-generate every cmd/cell page any time the git sha changes.
Also change cmd gen to match.
 2024-10-15 07:16:40 +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
Krystine Sherwin 17ee367c7b
Docs: Use Read the Docs SPHINXOPTS 
`-W --keep-going` will build everything but raise an error on any warnings.  Should mean that github actions will correctly flag a failure when attempting to build docs.  Including this current commit until the `internal_stats` command gets a help message.
 2024-09-05 15:47:18 +12:00
Emily Schmidt 7de8be1451 functional_ir.rst: fix typo, document SExprWriter::flush 2024-09-03 14:30:56 +01:00
Emily Schmidt 75ed6d38fc fix rst formatting in functional_ir.rst 2024-09-03 14:21:56 +01:00
Miodrag Milanovic 9ed031ddd5 Fix TODOs in docs 2024-09-03 12:28:25 +02:00
Miodrag Milanovic 3e0dc2ff1e Release version 0.45 2024-09-03 10:28:56 +02:00
Emily (aiju) c0ce0b82a8 docs: gvpack on macos requires the file name to appear after the flags 2024-09-03 08:38:29 +02:00
Krystine Sherwin 558f313a78
Docs: Show todos in previews 
That includes local builds.
Also fix release version numbers.
 2024-09-03 11:53:43 +12:00
Krystine Sherwin 840c515ffc
RTDs: Fail on warning 
Fix outstanding sphinx warnings;
- Change mycells.lib to use `text` parsing instead of (currently) unsupported `Liberty`.
- Remove unused `troubleshooting.rst`, moving the todo into the index.
 2024-09-03 10:20:24 +12:00
Emily Schmidt 4eeb8d326a functional backend: rename "type" to either "kind" or "sort" to make the terminology consistent 2024-08-28 12:39:41 +01:00
Emily Schmidt 27efed27c2 functional backend: more documentation 2024-08-28 11:28:24 +01:00
Emily Schmidt 459e6b913a add functional ir documentation 2024-08-27 11:11:02 +01:00
Krystine Sherwin ecff434886
Docs: Use version name from readthedocs 
Latest still gets -dev, but if it's a docs preview use the tag/branch name.
 2024-08-27 10:21:31 +12:00
Krystine Sherwin 98d26bdd2c
Docs: Fix nested list on build_verific page 2024-08-27 10:06:26 +12:00
Krystine Sherwin 5d5d890d5b
Docs: macos-safe build 
Swap `cp -u` for `rsync -t`.
Drop the workaround to get the list of dot files after copying them, and instead just run the makefile twice.
Swap `$(wildcard **/*.x)` for `$(shell find . -name *.x)`,
 2024-08-27 10:06:25 +12:00
Krystine Sherwin 2e1335a023
Docs: Fix local builds 
Based on the docs-test-fork PR branch, includes PR preview announcement, linking to the relevant tyrtd page
 2024-08-27 10:06:25 +12:00
Krystine Sherwin 583d820dc2
Docs: Apply verific docs suggestions 2024-08-23 09:23:57 +12:00
Krystine Sherwin 3317d80480
Docs: Clarify verific caveats 2024-08-22 10:04:00 +12:00
Krystine Sherwin 6431534c24
Docs: Some other fixes 2024-08-22 10:03:59 +12:00
Krystine Sherwin 8145461c78
Docs: Fix Verific builds table formatting 
PDF don't like the long headers, so instead use placeholders a-d with elaborations below.
 2024-08-22 10:03:59 +12:00
Krystine Sherwin 0327ad97f2
Docs: Fix code formatting 
Gets me everytime
 2024-08-22 10:03:59 +12:00
Krystine Sherwin 36ad07e1d5
Docs: Update build_verific 
Clarify partially supported builds section.
Update parameter defaults.
Include note on finding compile options with `yosys-config`.
Fix remaining references to `/yosys_source/`.
 2024-08-22 10:03:59 +12:00
Krystine Sherwin 88bb785dcd
Docs: Verific but with sentences 2024-08-22 10:03:59 +12:00
Krystine Sherwin cfba26ca8b
Docs: Verific progress 2024-08-22 10:03:59 +12:00
Krystine Sherwin 00bb3b6fc2
Docs: Merge yosys_source into extending_yosys 
Move abc_flow content into synthesis/abc document.
 2024-08-22 10:03:59 +12:00
Krystine Sherwin 8e618cac45
Docs: Update build_verific.rst 
Move patch section to top.
Add todos for open questions.
Reformat partially supported builds into a single table.
General language tidy up/reflow.
 2024-08-22 10:03:59 +12:00
Krystine Sherwin 53b223f0df
Docs: Initial build_verific.rst 
From verific.md

Co-authored-by: Miodrag Milanovic <mmicko@gmail.com>
 2024-08-22 10:03:59 +12:00
Krystine Sherwin d97a243c22
Docs: Intro to Yosys source section 2024-08-22 10:03:59 +12:00
Krystine Sherwin e18a2f1e27
Docs: Section/folder for yosys source details 
Move test_suites page into said folder.
Placeholder page for building with verific.
 2024-08-22 10:03:58 +12:00