-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto merge of #4904 - alexcrichton:clean-docs, r=alexcrichton
Delete the old docs, lift up the new This commit deletes the old documentation now that the "official source" is the main book. The book is now lifted up directly into `src/doc` instead of `src/doc/book`. The CI no longer builds documentation and has been updated to just run mdbook to make sure there's no errors. The documentation will actually get published in the rust-lang/rust repo
- Loading branch information
Showing
66 changed files
with
48 additions
and
4,522 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,47 @@ | ||
# Cargo Documentation | ||
# The Cargo Book | ||
|
||
NOTE: Cargo documentation is under migration to mdBook-based structure. All the | ||
`*.md` files here shall be kept in sync with the `*.md` files under `book/src/`. | ||
See `MIGRATION_MAP` file here and <https://github.com/rust-lang/cargo/pull/4453> | ||
for details. | ||
|
||
### Requirements | ||
|
||
Building the book requires [mdBook]. To get it: | ||
|
||
[mdBook]: https://github.com/azerupi/mdBook | ||
|
||
```shell | ||
$ cargo install mdbook | ||
``` | ||
|
||
### Building | ||
|
||
To build the book: | ||
|
||
```shell | ||
$ mdbook build | ||
``` | ||
|
||
The output will be in the `book` subdirectory. To check it out, open it in | ||
your web browser. | ||
|
||
_Firefox:_ | ||
```shell | ||
$ firefox book/index.html # Linux | ||
$ open -a "Firefox" book/index.html # OS X | ||
$ Start-Process "firefox.exe" .\book\index.html # Windows (PowerShell) | ||
$ start firefox.exe .\book\index.html # Windows (Cmd) | ||
``` | ||
|
||
_Chrome:_ | ||
```shell | ||
$ google-chrome book/index.html # Linux | ||
$ open -a "Google Chrome" book/index.html # OS X | ||
$ Start-Process "chrome.exe" .\book\index.html # Windows (PowerShell) | ||
$ start chrome.exe .\book\index.html # Windows (Cmd) | ||
``` | ||
|
||
|
||
## Contributing | ||
|
||
Given that the book is still in a draft state, we'd love your help! Please feel free to open | ||
issues about anything, and send in PRs for things you'd like to fix or change. If your change is | ||
large, please open an issue first, so we can make sure that it's something we'd accept before you | ||
go through the work of getting a PR together. |
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.