search

esrlabs / northstar

Embedded container runtime
Apache License 2.0
171 stars 32 forks source link

Docs of northstar crate are hidden by main #394

Closed flxo closed 2 years ago

flxo commented 3 years ago

The main crate hides documentation for the northstar crate because it declares 

[[bin]]
name = "northstar"
path = "src/main.rs"

A cargo doc should generate doc also for the crate northstar.

flxo commented 2 years ago

Technically this is not solvable without renaming crates. The CI jobs generates only the docs for the northstar crate

cargo doc -p northstar --all-features --no-deps

The other crates do not provide any to be externally used API, so this is totally sufficient.

The docs are here