-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make Kconfig data visible in documentation #20437
Comments
71 tasks
I'd like to point to https://github.com/leandrolanzieri/RIOT/tree/pr/doc/kconfig_symbols where quite some time ago I started generating documentation from Kconfig. The approach was to generate header files when |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
We have good metadata about our configuration options in Kconfig, let's use them to make doc.riot-os.org better.
Currently, we have duplication of both the defaults (which may become unused even, going more towards Kconfig for tunables ([issue reference needed], @MrKevinWeiss is working on it AIU) and documentation.
Progress so far
RIOTBOARD=$PWD/boards/ RIOTCPU=$PWD/cpu/ RIOTPKG=$PWD/pkg KCONFIG_GENERATED_DEPENDENCIES=/does-not-exist KCONFIG_EXTERNAL_MODULE_CONFIGS=/does-not-exist KCONFIG_EXTERNAL_PKG_CONFIGS=/does-not-exist
.LWM2M_DEVICE_MODEL
defaults to"${BOARD}"
. (As a workaround, setting BOARD="${BOARD}" may make sense).This has a bunch of issues still -- it prints some literal symbols (
@var opaque(?) 5120
), and I've seen some duplication here and there, and not all items in here are really tunables, butdoesn't look half bad.
[edit: The updated snippet produces C source code, because Doxygen is very stubborn around having entities defined in non-code files; manually labeling them as @ref targets would work fine too]
The text was updated successfully, but these errors were encountered: