Commit Graph
32 Commits
Author SHA1 Message Date
Krystine Sherwin 38746ea5fa docs: Cross reference contributing
.md points to .html on latest
.rst points to .md on main (not that it will work before this is merged)
2025-02-20 14:16:41 +13:00
Krystine Sherwin c1f42f725b Docs: Formatting recent md -> rst converts 2024-12-05 09:21:12 +13:00
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
Krystine Sherwin e78841ba45 Docs: Fix invalid autorefs 2024-10-15 07:34:53 +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 edf29e725e Docs: Add functional_ir to index 2024-10-07 22:20:22 +13: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
Emily Schmidt 75ed6d38fc fix rst formatting in functional_ir.rst 2024-09-03 14:21:56 +01: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 98d26bdd2c Docs: Fix nested list on build_verific page 2024-08-27 10:06:26 +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 d97a243c22 Docs: Intro to Yosys source section 2024-08-22 10:03:59 +12:00
Krystine Sherwin 3a36612ec7 Docs: Apply invert-helper where needed 2024-05-11 10:40:54 +12:00
Rui Chen b57a803f60 chore: fix master branch refs
Signed-off-by: Rui Chen <[email protected]>
2024-03-24 00:41:54 -04:00
Krystine Sherwin f72ddfb09d docs: Fix repo file links 2024-03-19 05:57:26 +13:00
Krystine Sherwin 9878e69d6c Docs: tidying
- Use `:file:` role for file names, as well as `:makevar:` and `:program:`.
- Remove deprecated `linux-arm` and `linux-riscv64` oss-cad-suite targets.
- Add link to ABC.
- More (and better) links to code examples.  Formatted `:file:` text with link
  to source on github.
- Includes a few extra todos (mostly picking up inline code blocks and a couple
  intro reminders).
- Fixing a few missing `:yoscrypt:` and `:cmd:ref:` tags.
- Reflowing some paragraphs for spacing/width.
2024-01-30 13:31:00 +13:00
Krystine Sherwin 6e38848b92 Docs: updating makefiles 2024-01-25 12:35:03 +13:00
Krystine Sherwin f44e8d0124 Working on extensions doc
Moved the last files out of the resources directory.
Some tidy up/reformatting of the extensions to allow literalincludes from `my_cmd.cc`.
Most (all?) of the getting started guidelines file is either in the quick guide section, or sections referenced by it.  Instead of including it verbatim, we'll instead just leave a reference to it but then jump straight into the quick guide.
Include an image for the absval generated module.  Still needs more surrounding text but it's good enough for now.

Also includes some other minor tidying, including removing the no longer used abc_01 code example.
2023-12-13 11:34:42 +13:00
Krystine SherwinandLofty 1733a76273 Updated ABC info
Includes comparison of `abc` v `abc9`. Also creates a new subsection of the
yosys internals for extending yosys (moving the previous extensions.rst into it).

Co-authored-by: Lofty <[email protected]>
2023-12-13 10:08:45 +13:00