Code

Doc update working example#42

Code

Closed

SrikanthPagadarai wants to merge 56 commits intomainanalogdevicesinc/genalyzer:mainfrom doc-update-working-exampleanalogdevicesinc/genalyzer:doc-update-working-exampleCopy head branch name to clipboard

+7,340-6,810

Commits

Commits on Oct 4, 2024

• Added first draft of a minimal working example to explain genalyzer work flow

  Show description for 37c5871
  SrikanthPagadarai

  committed
  37c5871

  Copy full SHA for 37c5871

• Further updates to working example doc page

  Show description for 91c126e
  SrikanthPagadarai

  committed
  91c126e

  Copy full SHA for 91c126e

• More updates to working example page

  Show description for 7b50e40
  SrikanthPagadarai

  committed
  7b50e40

  Copy full SHA for 7b50e40

• Updates to working example page

  Show description for 7a20df0
  SrikanthPagadarai

  committed
  7a20df0

  Copy full SHA for 7a20df0

• Add doc for python bindings

  Show description for bf195f0
  tfcollins

  committed
  bf195f0

  Copy full SHA for bf195f0

• Merge pull request #41 from analogdevicesinc/tfcollins/doc-python-bindings

  Show description for da3fb49
  SrikanthPagadarai

  authored
  da3fb49

  Copy full SHA for da3fb49

• [WIP] Python docstrings

  Show description for b196804
  SrikanthPagadarai

  committed
  b196804

  Copy full SHA for b196804

Commits on Oct 7, 2024

• WIP: More updates to auto-generated Python bindings

  Show description for e592a4f
  SrikanthPagadarai

  committed
  e592a4f

  Copy full SHA for e592a4f

Commits on Oct 11, 2024

• WIP: More updates to working example page in doc

  Show description for fd3e275
  SrikanthPagadarai

  committed
  fd3e275

  Copy full SHA for fd3e275

• WIP: Added complete page on working example

  Show description for 07b0841
  SrikanthPagadarai

  committed
  07b0841

  Copy full SHA for 07b0841

Commits on Oct 14, 2024

• Removed the use of main function abstraction in the working example script

  Show description for aadcf51
  SrikanthPagadarai

  committed
  aadcf51

  Copy full SHA for aadcf51

• Update to conf.py to overcome cross-references related warnings in doc generation

  Show description for 5d88317
  SrikanthPagadarai

  committed
  5d88317

  Copy full SHA for 5d88317

• Updated github actions version from v2 to v4 to upload/download artifacts

  Show description for e8ef5aa
  SrikanthPagadarai

  committed
  e8ef5aa

  Copy full SHA for e8ef5aa

• Updated github actions version from v1 to v4 to upload/download artifacts

  Show description for 4f817d8
  SrikanthPagadarai

  committed
  4f817d8

  Copy full SHA for 4f817d8

• Downgraded github actions version from v4 to v3 to upload/download artifacts for CoverageTest

  Show description for 0e07220
  SrikanthPagadarai

  committed
  0e07220

  Copy full SHA for 0e07220

• Added tabulate to reuirements_test.txt

  Show description for 0b37bd9
  SrikanthPagadarai

  committed
  0b37bd9

  Copy full SHA for 0b37bd9

• Updated coverallsapp action version from v3 to v2 to upload/download artifacts for CoverageTest

  Show description for c68c17c
  SrikanthPagadarai

  committed
  c68c17c

  Copy full SHA for c68c17c

Commits on Oct 21, 2024

• Rewrite of pectral analysis doc page

  Show description for 1d4c800
  SrikanthPagadarai

  committed
  1d4c800

  Copy full SHA for 1d4c800

• Minor updates

  Show description for 4dae0bc
  SrikanthPagadarai

  committed
  4dae0bc

  Copy full SHA for 4dae0bc

Commits on Oct 22, 2024

• More updates to spectral analysis doc page

  Show description for 249c7b8
  SrikanthPagadarai

  committed
  249c7b8

  Copy full SHA for 249c7b8

Commits on Oct 23, 2024

• Updated directory of figure files used in doc

  Show description for 50cd0f1
  SrikanthPagadarai

  committed
  50cd0f1

  Copy full SHA for 50cd0f1

• Updated references to Python scripts in spectral analysis doc page

  Show description for 31b210b
  SrikanthPagadarai

  committed
  31b210b

  Copy full SHA for 31b210b

• Update to fix broken references to files

  Show description for cba6d50
  SrikanthPagadarai

  committed
  cba6d50

  Copy full SHA for cba6d50

• Reorg of Python bindings by renaming advanced module as pygenalyzer

  Show description for dc9830f
  SrikanthPagadarai

  committed
  dc9830f

  Copy full SHA for dc9830f

• Minor doc update

  Show description for 421a113
  SrikanthPagadarai

  committed
  421a113

  Copy full SHA for 421a113

• Update to Python bindings doc based on reorg

  Show description for 3972de8
  SrikanthPagadarai

  committed
  3972de8

  Copy full SHA for 3972de8

• Updated references to autogenerated API doc based on reorg

  Show description for 321eb2c
  SrikanthPagadarai

  committed
  321eb2c

  Copy full SHA for 321eb2c

• Changed references from master to main in doc page

  Show description for 477a737
  SrikanthPagadarai

  committed
  477a737

  Copy full SHA for 477a737

• Update to build library before doc generation in github actions

  Show description for 7e1c06b
  SrikanthPagadarai

  committed
  7e1c06b

  Copy full SHA for 7e1c06b

• Removed old doc pages

  Show description for de27339
  SrikanthPagadarai

  committed
  de27339

  Copy full SHA for de27339

• Updated rst files for Python bindings

  Show description for df1a5ed
  SrikanthPagadarai

  committed
  df1a5ed

  Copy full SHA for df1a5ed

• Updated path to figures in doc page

  Show description for 22b36cb
  SrikanthPagadarai

  committed
  22b36cb

  Copy full SHA for 22b36cb

• Doc-string fixes in c simplified bindings header file

  Show description for 477ee31
  SrikanthPagadarai

  committed
  477ee31

  Copy full SHA for 477ee31

• Added numpy to doc requirements file

  Show description for a23a9ef
  SrikanthPagadarai

  committed
  a23a9ef

  Copy full SHA for a23a9ef

• Update to install pygenalyzer module before doc generation

  Show description for 011d9dd
  SrikanthPagadarai

  committed
  011d9dd

  Copy full SHA for 011d9dd

• Minor fix to doc yml file

  Show description for e9e3f9a
  SrikanthPagadarai

  committed
  e9e3f9a

  Copy full SHA for e9e3f9a

Commits on Oct 29, 2024

• Update doc.yml

  SrikanthPagadarai

  authored
  c4a14fb

  Copy full SHA for c4a14fb

Commits on Nov 1, 2024

• Update doc.yml

  SrikanthPagadarai

  authored
  a824aab

  Copy full SHA for a824aab

• Update doc.yml

  SrikanthPagadarai

  authored
  1e00378

  Copy full SHA for 1e00378

• Update doc.yml

  SrikanthPagadarai

  authored
  f94be1e

  Copy full SHA for f94be1e

• Cleanup of doc

  Show description for ccea703
  SrikanthPagadarai

  committed
  ccea703

  Copy full SHA for ccea703

• More cleanup of doc

  Show description for d222595
  SrikanthPagadarai

  committed
  d222595

  Copy full SHA for d222595

• Renamed c bindings files

  Show description for 9d5da7b
  SrikanthPagadarai

  committed
  9d5da7b

  Copy full SHA for 9d5da7b

• Update doc.yml

  SrikanthPagadarai

  authored
  ff81805

  Copy full SHA for ff81805

• Update doc.yml

  SrikanthPagadarai

  authored
  dc6abc3

  Copy full SHA for dc6abc3

• Update doc.yml

  SrikanthPagadarai

  authored
  0602c41

  Copy full SHA for 0602c41

• Update doc.yml

  SrikanthPagadarai

  authored
  64c3170

  Copy full SHA for 64c3170

• Update doc.yml

  SrikanthPagadarai

  authored
  0011472

  Copy full SHA for 0011472

• Update doc.yml

  SrikanthPagadarai

  authored
  4f59762

  Copy full SHA for 4f59762

• More cleanup of doc

  Show description for 78c6da5
  SrikanthPagadarai

  committed
  78c6da5

  Copy full SHA for 78c6da5

• Added check to determine if c library is present in python bindings

  Show description for d3d4051
  SrikanthPagadarai

  committed
  d3d4051

  Copy full SHA for d3d4051

• Updated yml files to reflect changes in c header filenames

  Show description for c29f5ba
  SrikanthPagadarai

  committed
  c29f5ba

  Copy full SHA for c29f5ba

• Improvements to spectral analysis doc page with expanded code snippets to provide better context

  Show description for 4d89ae4
  SrikanthPagadarai

  committed
  4d89ae4

  Copy full SHA for 4d89ae4

• Minor edit to eh title of simplified C bindings page

  Show description for d631740
  SrikanthPagadarai

  committed
  d631740

  Copy full SHA for d631740

• Added missing index file for python bindings

  Show description for 9d29553
  SrikanthPagadarai

  committed
  9d29553

  Copy full SHA for 9d29553

• Added missing index file for simplified python bindings

  Show description for 417db9b
  SrikanthPagadarai

  committed
  417db9b

  Copy full SHA for 417db9b