Skip to content

Commit a44612f

Browse files
committed
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
2 parents a437b2e + 1271bb4 commit a44612f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+48
-4522
lines changed

.travis.yml

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,7 @@ matrix:
3434
script:
3535
- cargo test
3636
- cargo doc --no-deps
37-
- sh src/ci/dox.sh
38-
after_success: |
39-
[ $TRAVIS_BRANCH = master ] &&
40-
[ $TRAVIS_PULL_REQUEST = false ] &&
41-
[ $(uname -s) = Linux ] &&
42-
pip install ghp-import --user &&
43-
$HOME/.local/bin/ghp-import -n target/doc &&
44-
git push -qf https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages 2>&1 >/dev/null
37+
- (cd src/doc && mdbook build --no-create --dest-dir ../../target/doc)
4538

4639
exclude:
4740
- rust: stable
@@ -51,13 +44,10 @@ before_script:
5144
script:
5245
- cargo test
5346

54-
env:
55-
global:
56-
- secure: "hWheSLilMM4DXChfSy2XsDlLw338X2o+fw8bE590xxU2TzngFW8GUfq7lGfZEp/l4SNNIS6ROU/igyttCZtxZMANZ4aMQZR5E8Fp4yPOyE1pZLDH/LdQVXnROsfburQJeq+GIYIbZ01Abzh5ClpgLg5KX0H627uj063zZ7Ljo/w="
57-
5847
notifications:
5948
email:
6049
on_success: never
50+
6151
addons:
6252
apt:
6353
packages:

src/ci/dox.sh

Lines changed: 0 additions & 33 deletions
This file was deleted.

src/doc/CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/doc/MIGRATION_MAP

Lines changed: 0 additions & 12 deletions
This file was deleted.

src/doc/README.md

Lines changed: 46 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,47 @@
1-
# Cargo Documentation
1+
# The Cargo Book
22

3-
NOTE: Cargo documentation is under migration to mdBook-based structure. All the
4-
`*.md` files here shall be kept in sync with the `*.md` files under `book/src/`.
5-
See `MIGRATION_MAP` file here and <https://github.com/rust-lang/cargo/pull/4453>
6-
for details.
3+
4+
### Requirements
5+
6+
Building the book requires [mdBook]. To get it:
7+
8+
[mdBook]: https://github.com/azerupi/mdBook
9+
10+
```shell
11+
$ cargo install mdbook
12+
```
13+
14+
### Building
15+
16+
To build the book:
17+
18+
```shell
19+
$ mdbook build
20+
```
21+
22+
The output will be in the `book` subdirectory. To check it out, open it in
23+
your web browser.
24+
25+
_Firefox:_
26+
```shell
27+
$ firefox book/index.html # Linux
28+
$ open -a "Firefox" book/index.html # OS X
29+
$ Start-Process "firefox.exe" .\book\index.html # Windows (PowerShell)
30+
$ start firefox.exe .\book\index.html # Windows (Cmd)
31+
```
32+
33+
_Chrome:_
34+
```shell
35+
$ google-chrome book/index.html # Linux
36+
$ open -a "Google Chrome" book/index.html # OS X
37+
$ Start-Process "chrome.exe" .\book\index.html # Windows (PowerShell)
38+
$ start chrome.exe .\book\index.html # Windows (Cmd)
39+
```
40+
41+
42+
## Contributing
43+
44+
Given that the book is still in a draft state, we'd love your help! Please feel free to open
45+
issues about anything, and send in PRs for things you'd like to fix or change. If your change is
46+
large, please open an issue first, so we can make sure that it's something we'd accept before you
47+
go through the work of getting a PR together.
File renamed without changes.

src/doc/book/.gitignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

src/doc/book/README.md

Lines changed: 0 additions & 47 deletions
This file was deleted.

0 commit comments

Comments
 (0)