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
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
KrystalDelusion
a14dec79eb
Rst docs conversion ( #3496 )
...
Rst docs conversion
2022-11-15 12:55:22 +01:00