Adding Docs for Fayalite

General
1

I started adding some docs, it still needs a lot more work, but has enough already documented that it's probably worth reading: WIP adding docs · 190e440b35 - libre-chip/fayalite - Libre-Chip.org

Any feedback appreciated!

2

When running cargo doc, I'm getting:

warning: unresolved link to `_docs`
 --> crates/fayalite/src/lib.rs:7:26
  |
7 | //! [Main Documentation][_docs]
  |                          ^^^^^ no item named `_docs` in scope
  |
  = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
  = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default

warning: unresolved link to `crate::_docs::modules`
  --> crates/fayalite/src/lib.rs:21:28
   |
21 | /// See [Fayalite Modules][crate::_docs::modules]
   |                            ^^^^^^^^^^^^^^^^^^^^^ no item named `_docs` in module `fayalite`
3

I now ran cargo doc --features=unstable-doc, as shown in the CI file, and it solved the issue. Sorry about the noise.

1 Like
4

just added code to automatically run firtool, so now running the blinky example generates verilog: libre-chip/fayalite: Fayalite is a Rust library for designing digital hardware - Libre-Chip.org

cargo run --example=blinky -- verilog -o /tmp/blinky

generates presumably working verilog in /tmp/blinky/blinky.v