Part 2: Update of doxygen/sphinx documentation for LimeSuiteNG library public API.#178
Merged
Conversation
…ts with new public API members.
…interface functions.
…rs when configuring SDR device channels.
…that are present in the public API.
…nx C++ parser limitations.
…inx documentation.
…oxygen xml output.
…ues of translated doxygen pages.
commit 75ad2719815ce4c9136eff798ad8730d92a64af7
Author: Arnius <arnasg08@gmail.com>
Date: Mon Mar 23 16:00:56 2026 +0200
Updated doxs generation script.
commit 00dcf15d0b470b6131ec8d91487268b14596428a
Author: Arnius <arnasg08@gmail.com>
Date: Mon Mar 23 15:55:57 2026 +0200
DOCS: Updated index file for unsorted API.
commit 3bd4f19fea0fad20e0e36282a9a0ef2a9d2a6df8
Author: Arnius <arnasg08@gmail.com>
Date: Mon Mar 23 15:11:52 2026 +0200
DOCS: Deleted redundant sphinx documentation files.
commit 92733563e71b32fb2eb5753e3ac3f90d23506f84
Author: Arnius <arnasg08@gmail.com>
Date: Mon Mar 23 14:26:58 2026 +0200
DOCS: Doxygen fixes.
commit 3b55adda9c91bd4b27d6944b1eefc4db3189791b
Author: Arnius <arnasg08@gmail.com>
Date: Mon Mar 23 14:05:39 2026 +0200
Dox file name typo fix
commit d5e289cd939af7d20266e70362b8f2baa7c4192e
Author: Arnius <arnasg08@gmail.com>
Date: Mon Mar 23 12:49:33 2026 +0200
DOCS: Renamed script, provided description for the script module and added cmd arg parsing.
commit 455829e113da4354906cacfdc2669abf3b26431a
Author: Arnius <arnasg08@gmail.com>
Date: Mon Mar 23 12:20:55 2026 +0200
DOCS: Renamed doxygen page conversion script to better reflect the purpose of the script.
commit 43386d4920454867ef50a4661d04c028f19dd33d
Author: Arnius <arnasg08@gmail.com>
Date: Mon Mar 23 12:19:52 2026 +0200
DOCS: Renamed doxygen index files.
commit 5656ea2885572826e2a0d6873323c832ead7c7fb
Author: Arnius <arnasg08@gmail.com>
Date: Mon Mar 23 12:13:07 2026 +0200
DOCS: Removed redundant sphinx documentation files.
commit a96a3414ec61d592be7de34fee109b5dc03d09db
Author: Arnius <arnasg08@gmail.com>
Date: Fri Mar 20 16:46:23 2026 +0200
Clean up
commit 0d10f642a2916e89f11430236b02454b0206cbf3
Author: Arnius <arnasg08@gmail.com>
Date: Fri Mar 20 16:35:33 2026 +0200
Added doxygen page conversion to rst page feature to autogen script.
commit 02af2c63ddf972bfc5ad286d27d98d0141f06ba7
Author: Arnius <arnasg08@gmail.com>
Date: Fri Mar 20 12:13:08 2026 +0200
Initial python script for dox to rst auto convert.
Collaborator
Author
|
A note for the reviewers Will also provide an update to the sphinx documentation topic - "For Developers -> Documentation generation guide". Updated docs will include updated documentation build steps for linux and windows. |
Member
|
@Arnius Thanks. I'm just on with something else and hope to take a look later this week. I'll need to review changes to conf.py also and consider how we can merge these into the standard conf.py used across all projects. The idea is that this never gets modified and all project-specific config lives in project.py. That way when updating Sphinx we can safely just overwrite conf.py and requirements.txt in every project, thereby avoiding the hassle of these being potentially different for each project. |
rjonaitis
approved these changes
Mar 31, 2026
…teps for linux platform.
Collaborator
Author
|
Updated scripts for documentation generation both on Linux and Windows platforms. The developer page for documentation generation has also been updated. |
rjonaitis
approved these changes
Apr 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Contents of the update: