1
0
mirror of synced 2026-01-27 12:43:21 +00:00
Commit Graph

45 Commits

Author SHA1 Message Date
Krystine Sherwin
8e07030fee docs: update auxiliary programs
Now includes usage output, (hopefully) generated by the tool during the docs build process so it will always be up to date.
Included in makefile as `docs/usage` target.
Also some updates/additions to the description text, esp `yosys-filterlib` and `yosys-smtbmc`.
2023-11-01 10:15:58 +13:00
Krystine Sherwin
74c1fc1cdd docs: Reference chapters with doc tag
Fix some formatting.
2023-10-30 22:38:47 +13:00
Krystine Sherwin
d4e45cdccb docs: Stub new(er) auxlibs and auxprogs
Still need to actually be filled in.
Also rearranges auxlibs to be alphabetical order.
2023-10-30 11:21:31 +13:00
Krystine Sherwin
e49903f8b1 List all synth commands on synth page 2023-10-30 11:04:03 +13:00
Krystine Sherwin
a1c3755dd6 Fix typo 2023-10-30 10:35:23 +13:00
Krystine Sherwin
abd92225a3 Replace 010 and 012 with pdf
Comment out the body text and instead include just the abstract and a download link.
Also orphan the pages so they aren't accessible except by direct link, or via search.
2023-10-30 10:34:30 +13:00
Krystine Sherwin
17749ce688 docs: absolute cmd directory 2023-10-16 21:10:03 +13:00
Krystine Sherwin
ebcbb94a21 Fixing makefile 2023-10-12 04:50:27 +13:00
Krystine Sherwin
8335044c35 docs: reflowing selections doc
Combined presentation sections with appnote sections.
Moved a bunch of Yosys one-liners in-line.
Better reference in interactive investigation to memdemo as a part of advanced logic cone selection (esp. because the show commands use some of the advanced features)
2023-10-11 12:46:26 +13:00
Krystine Sherwin
c61ab7d627 docs: Tidying interactive investigation
More :numref: because I figured out they were only failing if I didn't do a full re-make.
Reflow first section a little to help readability.
Also includes a css change to prevent code block caption text from bunching into the caption number.
2023-10-11 11:13:06 +13:00
Krystine Sherwin
9e35848c8e docs: initial 011 selections move
Also deleting the 011 document.
2023-10-10 12:36:10 +13:00
Krystine Sherwin
a019c26b9d docs: Moving 011 into main body of manual
Mostly in the `more_scripting` section, with part of the intro in the `scripting_intro`.
Also includes an extra todo on the installation page and some extra notes on where to find `show` details where relevant.
2023-10-10 12:35:23 +13:00
Krystine Sherwin
b0f8059bce Moving images and static folders
Images now included relative to the `docs/source` folder instead of the rst file.
Also makes sure to add the updated `yosyshq.css` (which as a sidenote has ended up as `custom.css` in most of the other docs).
2023-10-10 10:12:50 +13:00
Krystine Sherwin
98d0e749d6 Merge updates from 'master' into krys/docs 2023-09-19 11:28:36 +12:00
Krystine Sherwin
10ecbe9f5b docs: updating memory mapping text
More complete code examples and confirming Verific support thanks to @povik
2023-09-19 11:26:57 +12:00
Krystine Sherwin
93c9bf2f5d docs: Updating todos 2023-09-19 11:21:15 +12:00
Krystine Sherwin
70c47690b3 Updating todo text and assorted fixes
Fix #3905 by removing emoji (and move the comment into the if block for less ambiguity).
Adds `latexmk` to README.

Note that latexpdf doesn't seem to like `cmd:ref` links, possibly because the
reference location is inside a latex comment block, but I was under the
impression that there was a reference location in there previously which was
working fine.  May be related to how the `cmd:def` block expands (or doesn't as
the case may be).
2023-08-28 10:09:43 +12:00
Krystine Sherwin
aad8a3b959 Rearrange command ordering and model checking
Now under the yosys flows section.
2023-08-28 10:02:06 +12:00
Krystine Sherwin
e2c0f8fc50 Some tidy up 2023-08-14 12:13:29 +12:00
Charlotte
f9d38253c5 ast: add PRIORITY to $print cells 2023-08-11 04:46:52 +02:00
Charlotte
843ad9331b cxxrtl: WIP: adjust comb display cells to only fire on change
Naming and use of statics to be possibly revised.
2023-08-11 04:46:52 +02:00
Charlotte
7f7c61c9f0 fmt: remove lzero by lowering during Verilog parse
See https://github.com/YosysHQ/yosys/pull/3721#issuecomment-1502037466
-- this reduces logic within the cell, and makes the rules that apply
much more clear.
2023-08-11 04:46:52 +02:00
Charlotte
c391ee7a0d docs: document simulation time format specifiers 2023-08-11 04:46:52 +02:00
Charlotte
202c3776e2 docs: elaborate $print documentation 2023-08-11 04:46:52 +02:00
Charlotte
2d7b8f71cc docs: first pass $print documentation 2023-08-11 04:46:52 +02:00
Krystine Sherwin
685da6a2e5 Converting a number of inline commands to refs
Also reflowing text for line width.
Maybe look into supporting commands with options?
2023-08-08 12:45:47 +12:00
Krystine Sherwin
8203a01ba9 Adding custom domain for cmdref 2023-08-08 11:51:57 +12:00
Krystine Sherwin
d8b8880ad6 Convert todo comments to directives
Could be left in for final version, but my current thinking is not?
2023-08-08 10:06:19 +12:00
Krystine Sherwin
ce9e56db47 Move the last presentation slides 2023-08-08 09:50:36 +12:00
Krystine Sherwin
afc25afaf9 Minor tidying 2023-08-07 12:58:52 +12:00
Krystine Sherwin
8ade2182b0 Move (most of) ExOth and ExAdv slides 2023-08-07 12:58:40 +12:00
Krystine Sherwin
7ab051778e Add copypaste reminder for typical_phases.rst 2023-08-07 10:40:36 +12:00
Krystine Sherwin
330a2272da Converting PRESENTATION_ExSyn 2023-08-04 10:29:14 +12:00
Krystine Sherwin
4b40372446 Tidy/reflow some things 2023-08-03 10:37:43 +12:00
Krystine Sherwin
2c75b103d6 Include test suites doc with note 2023-08-03 09:20:30 +12:00
Krystine Sherwin
9a9aa2c45a Finished presentation intro
Also some other tidy up.
2023-08-03 09:20:30 +12:00
Krystine Sherwin
20c2708383 Move presentation intro example
Rework images makefile a bit to get it to import and build from resources folder(s).
Currently requires running twice from a clean build due to the way it finds `.dot` files to convert.
2023-08-03 09:20:29 +12:00
Krystine Sherwin
cd6e63e1a9 Moved presentation_prog 2023-08-03 09:20:29 +12:00
Krystine Sherwin
045c04096e Reorganising documentation
Also changing to furo theme.
2023-08-03 09:20:29 +12:00
Krystine Sherwin
4f1cd66829 New structure headings
Also adds a note to readme for installing pdflatex if it's missing.
2023-08-03 09:20:24 +12:00
Charlotte
0c0171bd60 docs: RD_DATA is an output, not input 2023-06-21 17:21:04 +10:00
Krystine Sherwin
d1b86d2fcf docs: reflow memory map
Move additional notes up to the top and give it its own section.  Also reformat some paragraphs, and turn some bullet points into paragraphs.
Split supported patterns section into some kind of grouping.
Currently:
- SDP
- single-port RAM
- reset patterns
- asymmetric
- TDP
2023-06-19 12:05:51 +12:00
Krystine Sherwin
3aee765793 Initial version of memory mapping doc 2023-05-26 09:36:01 +12:00
KrystalDelusion
b9b5899cce Remove docs dependency on yosys repo (#3558)
* Copies guidelines files into docs/ for website

* Copying manual/CHAPTER_Prog for new docs

* Copying manual/APPNOTE_011... for new docs

Also adding faketime to list of packages for website build.

Co-authored-by: KrystalDelusion <krystinedawn@yosyshq.com>
2022-11-24 15:56:44 +01:00
KrystalDelusion
a14dec79eb Rst docs conversion (#3496)
Rst docs conversion
2022-11-15 12:55:22 +01:00