juniper/book
tyranron ef7a7e8229
Upgrade to 2021 Rust edition
- set 1.62 Rust as MSRV
- use new fmt syntax where possible
- refactor `.to_owned()`, `.to_string()` and `.into()` usage
- rename `IntoResolvable::into()` as `IntoResolvable::into_resolvable()` to disambiguate with `Into::into()`
- use `#[derive(Default)]` for enums where possible
- use `bool::then_some()` where possible
2022-07-13 15:20:10 +02:00
..
src Upgrade to 2021 Rust edition 2022-07-13 15:20:10 +02:00
tests Upgrade to 2021 Rust edition 2022-07-13 15:20:10 +02:00
.gitignore Rework CI and project toolchain (#1043) 2022-04-08 17:44:50 +03:00
book.toml Upgrade to 2021 Rust edition 2022-07-13 15:20:10 +02:00
README.md Rework CI and project toolchain (#1043) 2022-04-08 17:44:50 +03:00

Juniper Book

Book containing the juniper user guide.

Contributing

Requirements

The Book is built with mdBook.

You may install it with:

cargo install mdbook

Local test server

To launch a local test server that continually re-builds the Book and auto-reloads the page, run:

mdbook serve

# or from project root dir:
make book.serve

Building

You may build the Book to rendered HTML with this command:

mdbook build

# or from project root dir:
make book

The output will be in the _rendered/ directory.

Testing

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

cd tests/
cargo test

# or from project root dir:
cargo test -p juniper_book_tests

# or via shortcut from project root dir:
make test.book

Test setup

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

This is done using the skeptic crate.