Skip to content

Documentation update#185

Open
Arnius wants to merge 99 commits into
developfrom
docs-restruct
Open

Documentation update#185
Arnius wants to merge 99 commits into
developfrom
docs-restruct

Conversation

@Arnius
Copy link
Copy Markdown
Collaborator

@Arnius Arnius commented May 4, 2026

List of documentation updates:

  1. Updated documentation structure.
  2. Moved Developer Guide section content from reStructuredText style pages to Doxygen style pages.
  3. Added Introduction section with diagrams and flowcharts in Developer Guide section.
  4. Added CSR interface and its functions to Lime Suite NG API list.
  5. Added a simple section with example use of CSR interface in Lime Suite NG library guide book.
  6. Added description for limeCSR utility.
  7. Added description for limePPSDO utility.
  8. Fixed formatting and text paragraphs.

Looking forward to feedback and suggestions for any improvements.

Arnius added 30 commits April 22, 2026 15:45
@Arnius
Moved docs generation page to the top index tree.
74bda9d
@Arnius
DOCS: changed doxygen documentation mainpage and reconfigured cmake p…
456ab2b 
…roject doxygen target location.
@Arnius
Ported SDRdevice API quivalents and examples to doxygen.
e718874
@Arnius
Ported LMS API (legacy) pages to doxygen.
a97c669
@Arnius
Fix
fae825d
@Arnius
DOCS Formated sdrdevice quivalents table.
39c5258
@Arnius
DOCS: Fixed broken SDRDevice API member links.
364fe33
@Arnius
DOCS: Added missing referneces to SDRDevice equivalents.
3d864b3
@Arnius
DOCS: formating
7c6a848
@Arnius
Ported dev_tools/asan to doxygen.
7fb0a2a
@Arnius
DOCS: ported deb packages page to doxygen
f223f37
@Arnius
DOCS: ported ubsan page to doxygen
77fd9c2
@Arnius
DOCS: ported valgrind page to doxygen
49a87e0
@Arnius
DOCS: ported GUI tool to doxygen.
ea1574c
@Arnius
Moved gui tool images to global doxygen image folder
3b34a41
@Arnius
DOCS: Ported radioconda index and env setup pages to doxygen.
970d775
@Arnius
DOCS: Ported limesuiteng conda recipe to doxygen.
2e1b101
@Arnius
DOCS: Ported gnuradio plugin conda recipe page to doxygen.
8665ac4
@Arnius
DOCS: Ported conda metapkg recipe page to doxygen.
c4b8703
@Arnius
DOCS: added missing index files
fff048a
@Arnius
DOCS: renamed doxygen folder to limesuiteng_api to reflect the actual…
171684b 
… purpose of the folder.
@Arnius
DOCS: Moved images from developer/limesuiteng_api to developer/ branch.
7a9e20d
@Arnius
DOCS: Updated doxygen image path.
2a59237
@Arnius
DOCS: Merged SDRDevice API pages into LimeSuiteNG API reference page.
39c71e3
@Arnius
DOCS; updated limesuiteng_api index files.
02762f4
@Arnius
DOCS: updates to developer/ and developer/limesuiteng_api index files.
3b9b18c
@Arnius
DOCS: added index files for developer/distribution page.
b56734f
@Arnius
DOCS: Moved radioconda to distribution page
d2a948f
@Arnius
DOCS: updated index tree with distribution page.
7f34a2a
@Arnius
DOCS: index tree fixes.
9970fbc
Arnius added 12 commits May 4, 2026 12:50
@Arnius
DOCS: Updated diagrams summary in developer/ index page.
27e8f87
@Arnius
DOCS: Added missing link to windows radioconda env set up.
14d669b
@Arnius
DOCS: Added CSR interface to API list.
7bdb2db
@Arnius
DOCS: included CSR interface provided register R/W functions to API l…
4c678c4 
…ist.
@Arnius
DOCS: Fixed parameter description for ICSR::ioWrite64 function.
e269e59
@Arnius
DOCS: Added a brief example section about CSR interface access.
501634c
@Arnius
DOCS: Added limeCSR utility description
4232a5e
@Arnius
DOCS: Added description of limePPSDO utility.
a2a95bf
@Arnius
DOCS: format fixes
7363b32
@Arnius
DOCS: formating fixes
26d7a6f
@Arnius
Squashed commit of the following:
6a138fe 
commit 5950408
Author: Honcharenko.D <rogalikck@gmai.com>
Date:   Thu Apr 23 20:28:09 2026 +0300

    streaming: fix StreamTx timestamp conversion for sample ticks

    Keep sample-tick semantics when converting StreamMeta to StreamTxMeta so StreamTx(waitForTimestamp=true) schedules transmission correctly.

commit 61b9e97
Author: Tomserv-512 <t.servenikas@limemicro.com>
Date:   Fri Apr 24 13:43:07 2026 +0300

    Update gw version check in XTRX oemtest

commit f2193c9
Author: Andrew Back <andrew@abopen.com>
Date:   Thu Apr 23 20:25:06 2026 +0100

    Docs: update project.py.

commit 5a19915
Author: Andrew Back <andrew@abopen.com>
Date:   Thu Apr 23 19:58:11 2026 +0100

    Docs: update workflow to use correct branch.

commit b954816
Author: Andrew Back <andrew@abopen.com>
Date:   Thu Apr 23 19:46:47 2026 +0100

    Docs: update workflow to use Cloudflare Worker.
@Arnius
DOCS: developer/distribuition index summary fix.
6f62cff
@Arnius Arnius requested review from 9600 and rjonaitis May 4, 2026 14:40
rjonaitis
rjonaitis requested changes May 5, 2026
View reviewed changes
Comment thread docs/developer/limesuiteng_api/related_pages/library_guide_book/device_discovery.dox Outdated
Comment thread docs/developer/limesuiteng_api/related_pages/library_guide_book/device_discovery.dox Outdated
Comment thread docs/developer/limesuiteng_api/related_pages/library_guide_book/device_discovery.dox Outdated
Comment thread docs/developer/tools/Asan.dox Outdated
Comment thread docs/developer/tools/UBSan.dox Outdated
Comment thread docs/developer/tools/Valgrind.dox Outdated
Comment thread docs/developer/tools/index.rst
Comment thread docs/developer/distribution/DebianPackaging.dox Outdated
Comment thread docs/developer/distribution/DebianPackaging.dox Outdated
@Arnius Arnius requested a review from rjonaitis May 5, 2026 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rjonaitis rjonaitis rjonaitis approved these changes

@9600 9600 Awaiting requested review from 9600

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Arnius @rjonaitis