Commit Graph

119 Commits

Author SHA1 Message Date
Karol Gugala
8e9aa0a6df docs: install and load sphinxcontrib.jquery
As per: https://github.com/readthedocs/sphinx_rtd_theme/issues/1452

Signed-off-by: Karol Gugala <kgugala@antmicro.com>
2024-03-17 20:02:56 +01:00
Tim 'mithro' Ansell
c64c430220 Remove Python version restriction.
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
2024-03-17 12:59:31 -05:00
Sean Cross
5adb89fedf requirements: fix hardware schematics
The markdown flavour we use appears to be very, very sensitive
to spacing, and will silently drop the entire table if it isn't
properly space-aligned.

Fix this, fix the path to the schematic PDF, and remove the extra
files added by the previous commit.

Signed-off-by: Sean Cross <sean@xobs.io>
2022-09-06 05:06:06 -07:00
Sean Cross
29b69b95bd hardware: copy schematics to this directory
Since `..` links don't work, just copy the files here.

Signed-off-by: Sean Cross <sean@xobs.io>
2022-09-05 22:14:11 -07:00
Sean Cross
8285d9bd3b Revert "hardware: update link to the schematic"
Undo the previous commit. Apparently you can't have `..` directories
in this flavour of markdown.
This reverts commit c51fe4f7dd.
2022-09-05 22:12:04 -07:00
Sean Cross
c51fe4f7dd
hardware: update link to the schematic
The schematics are not under `requirements`, but instead are under `_static`
2022-09-06 01:02:52 -04:00
Unai Martinez-Corral
d42ebd7714 docs/requirements: bump sphinx 2022-04-04 15:37:36 +02:00
Piotr Zierhoffer
476964601c
doc: Switch conda to use litex-hub (#605) 2022-01-12 12:39:58 +01:00
Roy Ragsdale
b993c14e5f Explicitly state how to enable non-privileged access to ttyACM
Also move the warning on the impacts to before the command.
2021-11-10 19:10:38 -05:00
Roy Ragsdale
a6e03bc608 doc: Add comment on /dev/ttyACM permissions and dialout group
Addresses #75.

Modeled on the udev section on adding a user to the `plugdev` group.

https://workshop.fomu.im/en/latest/requirements/drivers.html#steps-to-set-up-udev-rule
2021-11-09 21:54:02 -05:00
Unai Martinez-Corral
11679c55b7
docs: remove unused dependency 'symbolator' (#551) 2021-09-24 02:12:26 +02:00
Johan Euphrosine
1965272046
docs/risc-v: fix tinyusb firmware path (#511) 2021-08-24 04:20:02 +02:00
umarcor
43ceb55ade docs: fix conda env (pypa/pip#10237) 2021-08-07 16:12:29 +02:00
Unai Martinez-Corral
9818174c87
docs/migen: fix binary path (#510) 2021-07-30 17:36:27 +01:00
ProbablyMatt
9d90aa685f
docs: update references to hdl sources (#508)
All these point to 404s on the current workshop docs. Updated to point into hdl/ , except for migen which is top level
2021-07-29 19:03:29 +02:00
Tim Ansell
8b1fbc061f
Merge pull request #512 from proppy/mixed-hdl-formatting
docs/mixed-hdl: fix formatting
2021-07-29 09:16:19 -07:00
Johan Euphrosine
110627c992 docs/mixed-hdl: fix formatting 2021-07-29 17:42:58 +09:00
Johan Euphrosine
49050deda1 docs/migen: fix binary path 2021-07-29 17:31:04 +09:00
Johan Euphrosine
66223e49b2 docs/background: fix typos 2021-07-29 17:11:35 +09:00
umarcor
5d81ee11ae docs: style 2021-05-31 19:46:33 +02:00
umarcor
e0684433a9 docs/requirements/software: add subsection about Containers 2021-05-31 19:46:33 +02:00
umarcor
cb7a6e8a6b docs: add favicon 2021-05-20 13:38:32 +02:00
umarcor
4a5caa37b5 create subdir 'hdl' 2021-05-19 16:24:52 +02:00
umarcor
e1f025be03 doc: temporarily pin sphinx<4.0.0 2021-05-17 21:47:24 +02:00
umarcor
bc204ddc7e doc/icestudio: update section 'Board rules' 2020-11-26 15:48:42 +01:00
Juan Manuel Rico
d775959e0d icestudio: add Blinky variant with 'Board rules' 2020-11-26 15:48:42 +01:00
umarcor
6b61c70376 doc/icestudio: no need to get apio from git anymore 2020-11-25 15:43:54 +01:00
Juan Manuel Rico
14e567d845 doc: add IceStudio module navigation screenshots 2020-11-24 21:08:20 +01:00
umarcor
c2302bcae7 doc: add IceStudio Blinky video 2020-11-24 20:39:56 +01:00
umarcor
0dd555e784 docs: update HDLs 2020-11-08 02:04:12 +01:00
umarcor
f6641f398e docs: update background 2020-11-08 00:46:22 +01:00
umarcor
e0556b2727 docs: redo fomu-block-diagram in drawio 2020-11-08 00:46:22 +01:00
umarcor
cefed37826 docs: update background images 2020-11-08 00:46:22 +01:00
umarcor
f854071a98 docs: update requirements 2020-11-08 00:43:08 +01:00
umarcor
e72af33b9c docs: fix requirements; it's 'Zadig', not 'Zadeg' 2020-11-08 00:42:40 +01:00
umarcor
4a3ab6fe2d docs: update index 2020-11-08 00:32:47 +01:00
Tim Ansell
6828927bd3
Merge pull request #350 from tcal-x/blinklink
Fix link for riscv-blink csr.h.
2020-10-24 12:08:34 -07:00
Tim Callahan
e801208a54 Add 'sphinx.ext.extlinks' to extensions.
Signed-off-by: Tim Callahan <tcal@google.com>
2020-10-15 13:15:48 -07:00
Tim Callahan
f01ad515f2 Remove underscores at end of new link.
Signed-off-by: Tim Callahan <tcal@google.com>
2020-10-15 12:48:43 -07:00
Tim Callahan
b0c67c7f69 Try extlinks / :repo: style link from docs to code.
Signed-off-by: Tim Callahan <tcal@google.com>
2020-10-15 12:38:21 -07:00
Tim Callahan
691fdc5e03 Fix link for riscv-blink csr.h.
Signed-off-by: Tim Callahan <tcal@google.com>
2020-10-15 11:33:14 -07:00
umarcor
aef838f775 doc: update icestudio Blink guidelines 2020-10-15 17:41:16 +02:00
umarcor
e1d2fa25a9 doc: clarify Icestudio installation steps 2020-10-15 17:41:15 +02:00
Juan Manuel Rico
20e9eb7b03 doc: add IceStudio screenshot, enumerate steps 2020-10-15 17:41:15 +02:00
umarcor
9a33a5ce36 doc: add 'icestudio' 2020-10-15 17:41:15 +02:00
umarcor
b2601169f6 add mixed-hdl/blink 2020-10-12 19:58:46 +02:00
umarcor
4c7322cacd doc: add labels to HDL sections 2020-10-12 19:58:46 +02:00
umarcor
f88d97d7e7 docs: update and split requirements 2020-10-12 19:58:46 +02:00
umarcor
21bcde2bd3 add vhdl/blink 2020-10-12 18:48:52 +02:00
umarcor
ab04edaac1 doc: verilog/blink does not expose signals 2020-10-12 05:12:29 +02:00