Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Delete the old docs, lift up the new #4904

Merged
merged 1 commit into from
Jan 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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