Skip to content

feat: MDBook keeper tests #212

Open
Open
@Autoparallel

Description

@Autoparallel

Right now we have a commented out preprocessor for the MDBook:

# TODO (autoparallel): there's a bunch to fix with this
# [preprocessor.keeper]
# command     ="mdbook-keeper"
# manifest_dir="."
# externs     =["ronkathon", "rand"]

If we uncomment this, code snippets in the book will run and be checked like doctests, which is nice. However, many of these are broken as is.

To replicate:
Make sure you:

cargo install mdbook
cargo install mdbook-keeper

Then from the root:

mdbook build

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions