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

Redirect nightly apidoc to doc.rust-lang.org/nightly/nightly-rustc/cargo #11568

Merged
merged 4 commits into from
Jan 12, 2023
Merged
Show file tree
Hide file tree
Changes from 3 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
7 changes: 0 additions & 7 deletions .github/workflows/contrib.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,6 @@ jobs:
mkdir mdbook
curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.9/mdbook-v0.4.9-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
echo `pwd`/mdbook >> $GITHUB_PATH
- name: Update toolchain
run: rustup update --no-self-update stable && rustup default stable
- name: Build API doc
run: |
cargo doc --document-private-items --no-deps
- name: Deploy docs
run: |
cd src/doc/contrib
Expand All @@ -38,8 +33,6 @@ jobs:
git update-ref -d refs/heads/gh-pages
rm -rf contrib
mv ../book contrib
# Move rustdoc under contrib/
mv ../../../../target/doc contrib/apidoc
git add contrib
git commit -m "Deploy $GITHUB_SHA to gh-pages"
git push --force
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@
- External subcommands can now inherit jobserver file descriptors from Cargo.
[#10511](https://github.com/rust-lang/cargo/pull/10511)
- Added an API documentation for private items in cargo-the-library. See
<https://doc.crates.io/contrib/apidoc/cargo>.
<https://doc.rust-lang.org/nightly/nightly-rustc/cargo>.
[#11019](https://github.com/rust-lang/cargo/pull/11019)

### Changed
Expand Down
4 changes: 2 additions & 2 deletions src/cargo/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
//! There are two places you can find API documentation of cargo-the-library,
//!
//! - <https://docs.rs/cargo> and
//! - <https://doc.crates.io/contrib/apidoc/cargo>.
//! - <https://doc.rust-lang.org/nightly/nightly-rustc/cargo>.
//!
//! Each of them targets on a slightly different audience.
//!
Expand All @@ -33,7 +33,7 @@
//!
//! ## For Cargo contributors
//!
//! The documentation on <https://doc.crates.io/contrib/apidoc/cargo> contains all items in Cargo.
//! The documentation on <https://doc.rust-lang.org/nightly/nightly-rustc/cargo> contains all items in Cargo.
//! Contributors of Cargo may find it useful as a reference of Cargo's implementation details.
//! It's built with `--document-private-items` rustdoc flag,
//! so you might expect to see some noise and strange items here.
Expand Down
3 changes: 3 additions & 0 deletions src/doc/contrib/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,6 @@ authors = ["Eric Huss"]

[output.html]
git-repository-url = "https://github.com/rust-lang/cargo/tree/master/src/doc/contrib/src"

[output.html.redirect]
"/apidoc/cargo/" = "https://doc.rust-lang.org/nightly/nightly-rustc/cargo/"
jofas marked this conversation as resolved.
Show resolved Hide resolved