Skip to content
Snippets Groups Projects

feat: Render top-level docs using mdbook

Merged feat: Render top-level docs using mdbook
docs/mdbook into main
Merged David Runge requested to merge docs/mdbook into main
  1. Dec 05, 2024
    • David Runge's avatar
      ci(gitlab-ci): Render mdbook for GitLab pages · c8313967
      David Runge authored 
      
Instead of only rendering the Rust documentation, render relevant
top-level documentation using mdbook and move the Rust documentation to
a rustdoc subdirectory in the documentation output.

Signed-off-by: default avatarDavid Runge <dvzrv@archlinux.org>
      Verified
      c8313967
    • David Runge's avatar
      feat: Render top-level docs using mdbook · 627a0880
      David Runge authored 
      Rely on mdbook to render top-level documentation in a concise manner.
Using the `build-book` just recipe the mdbook (including adhoc addition
of js requirements for nermaid graphs) is built from a preselected list
of documentation files.
Afterwards all Rust documentation is collected in a `rustdoc`
subdirectory of the shared documentation output directory.

The `watch-book` and `serve-book` just recipes enable a worklow in which
relevant files are watched and the output dir is continuously served
using an adhoc webserver.

Fixes: #124


Signed-off-by: default avatarDavid Runge <dvzrv@archlinux.org>
      Verified
      627a0880