https://github.com/riot-os/rust-documentation-builder

https://github.com/riot-os/rust-documentation-builder

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/riot-os/rust-documentation-builder
• Owner: RIOT-OS
• Created: 2024-08-23T07:55:34.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-21T14:08:52.000Z (2 months ago)
• Last Synced: 2024-10-21T22:38:52.580Z (2 months ago)
• Language: Makefile
• Size: 31.3 KB
• Stars: 0
• Watchers: 10
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# riot-doc-helpers

## RIOT documentation helper

This crate contains neither actual code or documentation, but its build infrastructure is

suitable to produce rustdoc output for all crates in the RIOT ecosystem.

See the [RIOT documentation on Rust](https://doc.riot-os.org/using-rust.html) for how to use Rust on RIOT.

That page contains pointers to all the relevant components.

## Rationale for this repository's existence

All documented crates depend on `riot-sys` crate, at least transitively -- and that crate

requires

* a RIOT checkout,

* environment configuration as provided by `make info-rust`, and

* C2Rust to be installed.

As those can not be provided on , documentation needs to be built using a

more manual process, and this repository sets it up.

Parts of `riot-wrappers` depend on concrete RIOT modules to be enabled as part of their

environment configuration. This repository's Makefile picks a board and modules to maximize the

coverage -- at least until a way is found to build `riot-sys` with some maximal configuration.

(Which documented items depend on which modules is documented in the produced HTML thanks to

the [`doc_auto_cfg` feature](https://github.com/rust-lang/rust/issues/43781)).

License: LGPL-2.1