Christoph Herzog 9623e4d326 (book) Update and fix book compilation and tests

* Use mdbook for building the book
* Update book config
* Update book hierarchy to work properly with mdbook
    This necessitated adding place-holder index pages
    since mdbook does not suppoert stand-alon menu items
* Update tests to use 2018 edition
* Fix various compilation errors in the tests

2019-03-08 11:47:13 +01:00

833 B

Raw Blame History

Juniper Book

Book containing the Juniper documentation.

Contributing

Requirements

The book is built with mdBook.

You can install it with:

cargo install mdbook

Starting a local test server

To launch a local test server that continually re-builds the book and autoreloads the page, run:

mdbook serve

Building the book

You can build the book to rendered HTML with this command:

mdbook build

The output will be in the ./_rendered directory.

Running the tests

To run the tests validating all code examples in the book, run:

cd ./tests
cargo test

Test setup

All Rust code examples in the book are compiled on the CI.

This is done using the skeptic library.

833 B Raw Blame History