From 51271e5000c8256dea186430073a165ef86fa833 Mon Sep 17 00:00:00 2001 From: Shing Lyu Date: Sat, 24 Nov 2018 10:36:17 +0100 Subject: [PATCH] Added link to documentation in README --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b7b7c6e50f..2938263e8a 100644 --- a/README.md +++ b/README.md @@ -32,10 +32,13 @@ Or use the interactive shell: Currently the project is in an early phase, and so is the documentation. -You can generate documentation by running: +You can read the [online documentation](https://rustpython.github.io/website/rustpython/index.html) for the latest code on master. + +You can also generate documentation locally by running: ```shell -$ cargo doc +$ cargo doc # Including documentation for all dependencies +$ cargo doc --no-deps --all # Excluding all dependencies ``` Documentation HTML files can then be found in the `target/doc` directory.