Skip to content

Commit ee2fb20

Browse files
Merge pull request RustPython#205 from RustPython/readme-update
Added link to documentation in README
2 parents a8fb2f3 + 51271e5 commit ee2fb20

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,13 @@ Or use the interactive shell:
3232

3333
Currently the project is in an early phase, and so is the documentation.
3434

35-
You can generate documentation by running:
35+
You can read the [online documentation](https://rustpython.github.io/website/rustpython/index.html) for the latest code on master.
36+
37+
You can also generate documentation locally by running:
3638

3739
```shell
38-
$ cargo doc
40+
$ cargo doc # Including documentation for all dependencies
41+
$ cargo doc --no-deps --all # Excluding all dependencies
3942
```
4043

4144
Documentation HTML files can then be found in the `target/doc` directory.

0 commit comments

Comments
 (0)