Miodrag Milanovic
9c447ad9d4
Release version 0.56
2025-08-07 07:59:29 +02:00
Krystine Sherwin
3959d19291
Reapply "Add groups to command reference"
...
This reverts commit 81f87ce6ed
2025-08-06 13:52:12 +12:00
Krystine Sherwin
3784f6b17f
Docs: Bugpoint fixups from JF
...
Also dropping the `autosectionlabel_maxdepth = 1` so that I can actually use the auto section labels.
Adds warning on bash substitution on scripting intro page when talking about `yosys -p`.
2025-08-05 09:53:57 +12:00
N. Engelhardt
81f87ce6ed
Revert "Add groups to command reference"
2025-07-23 14:41:49 +00:00
Krystine Sherwin
0ec336ba23
Docs: Add :cmd:title: directive
...
Calling :cmd:title:`<cmd>` will generate a cross reference to `<cmd>`, but unlike :cmd:ref: which displays a literal block and puts the title (short_help) in the hovertext (the title field of an a-ref), :cmd:title: will display "<cmd> - <short_help>" as plain text.
Thus replacing the previous use case of referring to :doc:`cmd/<cmd>`.
Also refactor util py scripts to have more descriptive names.
2025-07-21 10:35:19 +12:00
Krystine Sherwin
f5ace20bf6
Docs: Improve autoref
...
Fix `help $cell` type references, as well as actually implement the fallback to yoscrypt.
2025-07-21 10:33:31 +12:00
Krystine Sherwin
714790c70b
Docs: Proto doc_string approach for cmd help
...
Add `doc_string` field to `Pass` constructor
Add `docs/util/newcmdref.py` to contain command domain
Update `docs/util/cmdref.py` with `cmd:usage` and `cmd:optiongroup` for describing commands.
Functional, but WIP.
2025-07-21 10:33:31 +12:00
Miodrag Milanovic
60f126cd00
Release version 0.55
2025-07-07 11:26:04 +02:00
Miodrag Milanovic
db72ec3bde
Release version 0.54
2025-06-09 07:23:54 +02:00
Miodrag Milanovic
53c22ab7c0
Release version 0.53
2025-05-06 07:45:16 +02:00
Miodrag Milanovic
fee39a3284
Release version 0.52
2025-04-09 07:38:42 +02:00
KrystalDelusion
644efca341
Merge pull request #4953 from YosysHQ/krys/local_docs_fixes
...
A few fixes, mostly local docs builds
2025-03-25 10:36:18 +13:00
Krystine Sherwin
39a1623ac0
Docs: Don't READTHEDOCS on local builds
2025-03-18 03:57:17 +13:00
Scott Ashcroft
d8af6b0616
docs: Add latex magic to make PDFs reproducible again
2025-03-14 21:48:08 +01:00
Miodrag Milanovic
c4b5190229
Release version 0.51
2025-03-12 08:31:37 +01:00
Miodrag Milanovic
b5170e1394
Release version 0.50
2025-02-11 07:55:17 +01:00
Miodrag Milanovic
427b5a251b
Release version 0.49
2025-01-21 14:59:09 +01:00
KrystalDelusion
0c61f1a9a8
conf.py: Fix source_directory
2025-01-20 16:30:30 +13:00
KrystalDelusion
ab4bda8ae2
Docs: Fix links for view/edit source
2025-01-20 16:19:36 +13:00
Miodrag Milanovic
aaa5347494
Release version 0.48
2024-12-11 08:35:36 +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
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
Miodrag Milanovic
647d61dd92
Release version 0.47
2024-11-05 07:59:25 +01:00
Krystine Sherwin
c6414e08eb
Docs: Switch to furo-ys for YoscryptLexer
2024-10-15 07:34:53 +13:00
Krystine Sherwin
5a4a4191af
Docs: Update conf.py for cellref
2024-10-15 07:26:04 +13:00
Krystine Sherwin
ccd3bace23
Docs: Add cells loc config value
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
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
Miodrag Milanovic
e97731b9dd
Release version 0.46
2024-10-09 08:08:00 +02: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
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
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
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
3b63ab07ae
docs: Build RTD artifacts directly
...
Use rtds-action instead of yosys-cmd-ref repo.
Add rtds_action to docs configuration.
Add `.readthedocs.yaml`.
Update `DOCS_USAGE_` make target to be able to use pre-generated executables without forcing a remake.
2024-08-16 10:43:51 +12:00
Miodrag Milanovic
80ba43d262
Release version 0.44
2024-08-06 09:42:28 +02:00
Miodrag Milanovic
c6e5e0b26b
Release version 0.43
2024-07-09 09:11:59 +02:00
Miodrag Milanovic
9b6afcf3f8
Release version 0.42
2024-06-07 08:29:48 +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
3596025283
docs: Remove TODOs from output
...
Remove highlighting of wreduce/opt_clean bug.
2024-03-05 05:44:40 +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
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
2c75b103d6
Include test suites doc with note
2023-08-03 09:20:30 +12:00
Krystine Sherwin
045c04096e
Reorganising documentation
...
Also changing to furo theme.
2023-08-03 09:20:29 +12:00
