Miodrag Milanovic
229300bb4a
replace unicode chars in rst to make pdf work
2024-05-13 17:37:24 +02:00
Miodrag Milanovic
fa19abad98
Fix rst syntax error
2024-05-13 16:44:42 +02:00
Miodrag Milanović
eba5fa8d64
Merge pull request #4387 from YosysHQ/emil/document-lut-sop
...
docs: Document $lut and $sop
2024-05-13 15:05:07 +02:00
Krystine Sherwin
3a36612ec7
Docs: Apply invert-helper where needed
2024-05-11 10:40:54 +12:00
Krystine Sherwin
9be7089f4f
Docs-css: Add invert-helper class for images
...
Use svg color filter matrix from @jix to invert brightness for images when using dark theme.
Co-authored-by: Jannis Harder <me@jix.one>
2024-05-11 10:40:28 +12:00
Krystine Sherwin
a4c3dcc5a0
docs: Fix macro_commands
...
Get absolute path for `TESTS_DIR` to work from `docs` directory or from `docs/tests` in addition to `yosys` directory.
2024-05-10 09:51:37 +12:00
Krystine Sherwin
6f602e79d4
docs: Debugging macro test fail
...
Call yosys-config post build extraction for sanity check.
Report absolute path for yosys exe if it can't be found.
2024-05-10 09:51:36 +12:00
Emil J. Tywoniak
fd84a3378e
docs: Document $lut and $sop
2024-05-09 18:31:18 +02:00
Miodrag Milanovic
c1ad37779e
Release version 0.41
2024-05-08 08:52:10 +02:00
Miodrag Milanovic
71f2540cd8
docs conf.py change Release -> Version
2024-05-07 15:55:52 +02:00
Miodrag Milanovic
b4034a881e
Keep docs version in conf.py
2024-05-07 15:35:25 +02:00
Krystine Sherwin
bb0be8c7a2
Docs: Set release to YOSYS_VER
...
If building from read the docs, and the current build is "latest", add `-dev` to the version string.
Requires `YOSYS_VER` to be exported by .readthedocs.yaml.
2024-05-04 16:51:29 +12:00
Krystine Sherwin
73d021562f
Docs: Rename source/temp to source/generated
2024-04-15 10:13:22 +12:00
Krystine Sherwin
953f5bbe6c
Docs: Remove end-before tag for yosys-abc
2024-04-15 09:50:46 +12:00
Krystine Sherwin
b3024289c6
Docs: Force read_verilog to avoid verific header
2024-04-13 11:33:04 +12:00
Krystine Sherwin
1d7b7ddfd7
Docs: Skip footer in logs
2024-04-13 11:29:11 +12:00
Miodrag Milanovic
e2cfcbcf25
fix .gitignore
2024-04-10 10:12:05 +02:00
Emil J. Tywoniak
43ef916f86
Restructure rst
2024-04-05 14:01:25 +02:00
Emil J. Tywoniak
9510293a94
fixup
2024-04-04 18:16:58 +02:00
Emil J. Tywoniak
a580a7c82c
docs: Document $macc
2024-04-03 20:37:54 +02:00
Rui Chen
b57a803f60
chore: fix master branch refs
...
Signed-off-by: Rui Chen <rui@chenrui.dev>
2024-03-24 00:41:54 -04:00
Krystine Sherwin
c6795cefc5
docs: Install python requirements
2024-03-19 06:05:03 +13:00
Krystine Sherwin
f72ddfb09d
docs: Fix repo file links
2024-03-19 05:57:26 +13:00
Krystine Sherwin
29c8a3bef9
docs: Fix splice.v in verific
2024-03-19 05:57:26 +13:00
Krystine Sherwin
49f1bea1d2
docs: Add synth_ice40 to macro checks
2024-03-18 11:01:09 +13:00
Krystine Sherwin
b6ffdec2ce
docs: Update OSS CAD suite info
2024-03-18 10:45:31 +13:00
Krystine Sherwin
2832034877
docs: Clarify install instructions
...
`config-clang` is the default, and doesn't need to be run first. Previous instructions were ambiguous about that point.
Add note on using a different `CXX`.
2024-03-18 10:35:01 +13:00
Krystine Sherwin
bc9cccacf2
docs: Move fifo localparams into module def
...
Fix for failing CI.
2024-03-18 10:02:40 +13:00
Krystine Sherwin
3635f911dc
Docs: Updates from @povik comments
2024-03-05 05:57:27 +13:00
Krystine Sherwin
1455941ab9
Merge branch 'master' into krys/docs
2024-03-05 05:48:46 +13:00
Krystine Sherwin
3596025283
docs: Remove TODOs from output
...
Remove highlighting of wreduce/opt_clean bug.
2024-03-05 05:44:40 +13:00
passingglance
5226d07721
Update CHAPTER_CellLib.rst
...
Fix parameter name to \WIDTH for $tribuf cell.
2024-02-11 23:59:07 -08:00
passingglance
2b89a5cced
Update CHAPTER_Basics.rst
...
Fix typo in Fig. 2.2 caption.
2024-02-10 10:52:20 -08:00
Krystine Sherwin
9eed04dd4b
Docs: Note on debug for memory_libmap
2024-02-05 15:38:01 +13:00
Catherine
c7bf0e3b8f
Add new `$check` cell to represent assertions with a message.
2024-02-01 20:10:39 +01:00
Krystine Sherwin
fae35fe98b
Docs: example_synth fifo update
...
More detail on `memory_libmap`, the `$__ICE40_RAM4K_` intermediate step, and the
bizarre opt output.
2024-01-30 13:34:29 +13:00
Krystine Sherwin
fd0c574942
Docs: changes/todos from JF
2024-01-30 13:33:07 +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
22808e0e3f
Docs: work on selections.rst
...
Highlighting the difference between `select prod %ci` and `select prod %ci2` by
introducing `sumproud.out` using the `dump` command.
Playing around with advanced cone example code.
2024-01-26 17:29:59 +13:00
Krystine Sherwin
e2e7065590
Docs: some restructure of advanced section
...
- Filling out index descriptions for `using_yosys` and `using_yosys/synthesis`.
- To discourage skipping over these index pages, the toctree in
`using_yosys/index` is hidden and instead has inline links to the two
subsections.
- Tidying todos.
- Moves technology mapping to `techmap_synth`, leaving the techmap by example in
the internals section. `yosys_flows` gets split up, with the coarse-grain
intro replaced by `synthesis/index`, the extract pass moving to
`synthesis/extract` and model checking to `more_scripting/model_checking`.
2024-01-26 13:08:22 +13:00
Krystine Sherwin
4582ab59da
Docs: intro to memory_libmap
2024-01-26 11:15:01 +13:00
Krystine Sherwin
6e38848b92
Docs: updating makefiles
2024-01-25 12:35:03 +13:00
Krystine Sherwin
2a14c72110
test-docs: target examples directly
2024-01-25 11:36:59 +13:00
Krystine Sherwin
57a7532227
Docs: add test-examples target
...
`test` becomes `test-macros`, with a new `test` calling both `test-*` targets.
2024-01-25 10:15:00 +13:00
Krystine Sherwin
9b820108d6
Docs: add test-docs.yml
2024-01-24 11:22:38 +13:00
Krystine Sherwin
449135a9d4
Docs: adding other macro command lists
...
Also updates `macro_commands.py` to skip empty lines, and moves comment
stripping earlier in parsing.
2024-01-24 10:29:40 +13:00
Krystine Sherwin
6c8949cacc
Docs: static opt macro list
...
Also adds `docs/tests/macro_commands.py` which checks all commands in
`code_examples/macro_commands` against the current yosys build. Format similar
to `run-test.sh` files: logging the file under test and reporting errors.
2024-01-24 09:56:00 +13:00
Krystine Sherwin
95849edbba
Docs: changes from JF
...
`yosys-witness` prereq `click`.
Yosys environment vars & `yosys --help` output.
Removing Ubuntu/macOS version numbers/names.
Hide `troubleshooting` page.
2024-01-23 17:35:06 +13:00
Krystine Sherwin
9ec1536f1f
Docs: getting_started tidy
...
Rename `show` intro and point to `/cmd/show`.
Add getting_started section overview.
2024-01-22 11:44:43 +13:00
Krystine Sherwin
65bb0d3059
Docs: updating to current 'master'
...
Pulling for #4133 and removing related TODO.
2024-01-22 11:18:07 +13:00