Code

docs: Cynthion documentation branch#33

Code

Merged

mossmann merged 36 commits intomaingreatscottgadgets/cynthion:mainfrom documentationgreatscottgadgets/cynthion:documentationCopy head branch name to clipboardJul 1, 2024

+1,002-5

Commits

Commits on Jun 28, 2024

• docs: Set language for sphinx documentation configuration

  antoinevg

  committed
  3f9b5a9

  Copy full SHA for 3f9b5a9

• docs: Bump sphinx_rtd_them to 2.0.0

  antoinevg

  committed
  cf2cf04

  Copy full SHA for cf2cf04

• docs: Draft outline

  antoinevg

  committed
  134515f

  Copy full SHA for 134515f

• docs: Add safety information

  antoinevg

  committed
  a2167ae

  Copy full SHA for a2167ae

• docs: bring documentation file names in line with hackrf doc conventions

  antoinevg

  committed
  e04b520

  Copy full SHA for e04b520

• docs: add information about facedancer examples

  antoinevg

  committed
  3c9b2a1

  Copy full SHA for 3c9b2a1

• docs: simplify facedancer example

  antoinevg

  committed
  297d4a8

  Copy full SHA for 297d4a8

• docs: add self-made hardware bringup guide

  antoinevg

  committed
  cf1f7e6

  Copy full SHA for cf1f7e6

• docs: moved facedancer examples to facedancer docs

  antoinevg

  committed
  6783837

  Copy full SHA for 6783837

• docs: add introduction page and product diagrams

  antoinevg

  committed
  72a88b0

  Copy full SHA for 72a88b0

• docs: add connection diagrams

  antoinevg

  committed
  f6849eb

  Copy full SHA for f6849eb

• docs: update safety information

  antoinevg

  committed
  5bb5cfd

  Copy full SHA for 5bb5cfd

• docs: clean up documentation organization

  antoinevg

  committed
  8ecf2a4

  Copy full SHA for 8ecf2a4

• docs: split apollo information into its own page

  antoinevg

  committed
  4ab1a33

  Copy full SHA for 4ab1a33

• docs: add a hardware connection diagram to 'getting started with usbproxy' section

  antoinevg

  committed
  4cf221a

  Copy full SHA for 4cf221a

• docs: flesh out developer documentation

  antoinevg

  committed
  bce1a5a

  Copy full SHA for bce1a5a

• docs: set width of cynthion photo on index page

  antoinevg

  committed
  d9c75a6

  Copy full SHA for d9c75a6

• docs: update Cynthion LED and button descriptions

  antoinevg

  committed
  8d6d568

  Copy full SHA for 8d6d568

• docs: break developer gateware/firmware docs into separate pages

  antoinevg

  committed
  da76a17

  Copy full SHA for da76a17

• docs: add autosectionlabel plugin to sphinx configuration

  antoinevg

  committed
  3e99552

  Copy full SHA for 3e99552

• docs: resolve all TODOs in the getting started section

  antoinevg

  committed
  f3f0db0

  Copy full SHA for f3f0db0

• docs: update cli documentation to refer to cynthion rather than apollo

  antoinevg

  committed
  070631d

  Copy full SHA for 070631d

• docs: drop reference to deprecated optional dependency 'gateware-soc'

  antoinevg

  committed
  434e2da

  Copy full SHA for 434e2da

• docs: add upgrade instructions to getting started document

  antoinevg

  committed
  1554a77

  Copy full SHA for 1554a77

• docs: updated placeholder images with shoot samples

  antoinevg

  committed
  f234271

  Copy full SHA for f234271

• docs: update getting started and bringup guide

  antoinevg

  committed
  88c6b9a

  Copy full SHA for 88c6b9a

• docs: add some examples for the docs to the cynthion python package

  antoinevg

  committed
  ebb76e3

  Copy full SHA for ebb76e3

• docs: update facedancer and usbproxy guides

  antoinevg

  committed
  d72f1e8

  Copy full SHA for d72f1e8

• docs: add dfu-util instructions to bringup guide

  antoinevg

  committed
  de28c3b

  Copy full SHA for de28c3b

• docs: update 'cynthion -h' output

  antoinevg

  committed
  9128f04

  Copy full SHA for 9128f04

• docs: fix labels for connection diagrams

  antoinevg

  committed
  f751c3a

  Copy full SHA for f751c3a

• docs: resize cynthion images and convert to jpg

  antoinevg

  committed
  c4c0f31

  Copy full SHA for c4c0f31

• docs: update docs with review feedback

  antoinevg

  committed
  5543e43

  Copy full SHA for 5543e43

• docs: update bringup guide bootloader lock instructions

  antoinevg

  committed
  d6c7f87

  Copy full SHA for d6c7f87

Commits on Jul 1, 2024

• docs: remove extraneous imports from documentation examples (tx @claui!)

  antoinevg

  committed
  9855b41

  Copy full SHA for 9855b41

• docs: update docs with @claui's review feedback

  antoinevg

  committed
  6bd03fd

  Copy full SHA for 6bd03fd