yume/juniper
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
juniper/docs/book
History
James H df2740393a
Add dataloader explaination to book (#518)
2020-02-12 23:45:15 -07:00
..
content Add dataloader explaination to book (#518) 2020-02-12 23:45:15 -07:00
tests Use caret requirement for specifying 'futures' crate version 2020-02-04 09:57:47 +01:00
.gitignore (book) Update and fix book compilation and tests 2019-03-08 11:47:13 +01:00
book.toml (book) Update and fix book compilation and tests 2019-03-08 11:47:13 +01:00
ci-build.sh Fix failure when no book content has changed 2019-05-03 00:39:33 -07:00
README.md (book) Update and fix book compilation and tests 2019-03-08 11:47:13 +01:00

README.md

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.