mschoi/RustPython
1
0
Fork 0
forked from Rust-related/RustPython
Code Pull Requests Actions Activity

Added link to documentation in README

Browse Source
This commit is contained in:
Shing Lyu
2018-11-24 10:36:17 +01:00
parent a8fb2f3754
commit 51271e5000
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -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.