Skip to content
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

doc: Enable all features #53

Open
chrysn opened this issue Feb 25, 2023 · 2 comments
Open

doc: Enable all features #53

chrysn opened this issue Feb 25, 2023 · 2 comments
Labels
help wanted Extra attention is needed

Comments

@chrysn
Copy link
Member

chrysn commented Feb 25, 2023

So far, there has been one chip for which all major features were usable (nrf52840), and thus the riot-wrappers could be documented based on that one. With #36 (DAC), this is no longer the case.

How can we build documentation that covers all features without having such a chip?

@chrysn chrysn added the help wanted Extra attention is needed label Feb 25, 2023
@chrysn
Copy link
Member Author

chrysn commented Feb 25, 2023

(This could also have been reported against https://gitlab.com/etonomy/riot-doc-helpers -- but a possible resolution is to replace that).

@Remmirad
Copy link

Remmirad commented Mar 8, 2023

I am not quite sure I understand the problem, but I tried to setup a little RIOT module e.g. generate (target: native), added all needed modules to its Makefile (grep'ed them from lib.rs), and then setup this crates .cargo/config.toml with something like this here:

[env]
RIOT_COMPILE_COMMANDS_JSON = "generated/compile_commands.json"
RIOT_USEMODULE = "all modules as obtained from riot compile output"
[build]
target = "native target"

This way I then could use cargo doc -F "features" to build the documentation that seems to include all specified modules.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants