Skip to content

Commit

Permalink
Auto merge of #4904 - alexcrichton:clean-docs, r=alexcrichton
Browse files Browse the repository at this point in the history
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
bors committed Jan 5, 2018
2 parents a437b2e + 1271bb4 commit a44612f
Show file tree
Hide file tree
Showing 66 changed files with 48 additions and 4,522 deletions.
14 changes: 2 additions & 12 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,7 @@ matrix:
script:
- cargo test
- cargo doc --no-deps
- sh src/ci/dox.sh
after_success: |
[ $TRAVIS_BRANCH = master ] &&
[ $TRAVIS_PULL_REQUEST = false ] &&
[ $(uname -s) = Linux ] &&
pip install ghp-import --user &&
$HOME/.local/bin/ghp-import -n target/doc &&
git push -qf https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages 2>&1 >/dev/null
- (cd src/doc && mdbook build --no-create --dest-dir ../../target/doc)

exclude:
- rust: stable
Expand All @@ -51,13 +44,10 @@ before_script:
script:
- cargo test

env:
global:
- secure: "hWheSLilMM4DXChfSy2XsDlLw338X2o+fw8bE590xxU2TzngFW8GUfq7lGfZEp/l4SNNIS6ROU/igyttCZtxZMANZ4aMQZR5E8Fp4yPOyE1pZLDH/LdQVXnROsfburQJeq+GIYIbZ01Abzh5ClpgLg5KX0H627uj063zZ7Ljo/w="

notifications:
email:
on_success: never

addons:
apt:
packages:
Expand Down
33 changes: 0 additions & 33 deletions src/ci/dox.sh

This file was deleted.

1 change: 0 additions & 1 deletion src/doc/CNAME

This file was deleted.

12 changes: 0 additions & 12 deletions src/doc/MIGRATION_MAP

This file was deleted.

51 changes: 46 additions & 5 deletions src/doc/README.md
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.
1 change: 0 additions & 1 deletion src/doc/book/.gitignore

This file was deleted.

47 changes: 0 additions & 47 deletions src/doc/book/README.md

This file was deleted.

Loading

0 comments on commit a44612f

Please sign in to comment.