Skip to content

Commit

Permalink
Say goodbye to GH Pages in favor of docs.rs
Browse files Browse the repository at this point in the history
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
  • Loading branch information
JohnTitor committed Oct 9, 2023
1 parent 0d6554f commit 14a7560
Show file tree
Hide file tree
Showing 5 changed files with 1 addition and 145 deletions.
20 changes: 0 additions & 20 deletions .github/workflows/bors.yml
Expand Up @@ -335,24 +335,6 @@ jobs:
- name: Build with check-cfg
run: LIBC_CI=1 LIBC_CHECK_CFG=1 cargo build -Z unstable-options -Z check-cfg=features,names,values,output

docs:
permissions:
actions: write # to cancel workflows (rust-lang/simpleinfra/github-actions/cancel-outdated-builds)
contents: read # to fetch code (actions/checkout)

name: Generate documentation
runs-on: ubuntu-22.04
needs: docker_linux_tier2
steps:
- uses: rust-lang/simpleinfra/github-actions/cancel-outdated-builds@HEAD
with:
github_token: "${{ secrets.GITHUB_TOKEN }}"
- uses: actions/checkout@v3
- name: Setup Rust toolchain
run: sh ./ci/install-rust.sh
- name: Generate documentation
run: LIBC_CI=1 sh ci/dox.sh

# These jobs doesn't actually test anything, but they're only used to tell
# bors the build completed, as there is no practical way to detect when a
# workflow is successful listening to webhooks only.
Expand All @@ -374,7 +356,6 @@ jobs:
build_channels_linux,
build_channels_macos,
build_channels_windows,
docs,
]

steps:
Expand All @@ -396,7 +377,6 @@ jobs:
build_channels_linux,
build_channels_macos,
build_channels_windows,
docs,
]

steps:
Expand Down
37 changes: 0 additions & 37 deletions .github/workflows/docs.yml

This file was deleted.

3 changes: 1 addition & 2 deletions README.md
Expand Up @@ -60,7 +60,7 @@ newer Rust features are only available on newer Rust toolchains:

## Platform support

[Platform-specific documentation (HEAD)][docs.head].
You can see the platform(target)-specific docs on [docs.rs], select a platform you want to see.

See
[`ci/build.sh`](https://github.com/rust-lang/libc/blob/HEAD/ci/build.sh)
Expand Down Expand Up @@ -107,4 +107,3 @@ dual licensed as above, without any additional terms or conditions.
[Documentation]: https://docs.rs/libc/badge.svg
[docs.rs]: https://docs.rs/libc
[License]: https://img.shields.io/crates/l/libc.svg
[docs.head]: https://rust-lang.github.io/libc/#platform-specific-documentation
82 changes: 0 additions & 82 deletions ci/dox.sh

This file was deleted.

4 changes: 0 additions & 4 deletions src/lib.rs
@@ -1,8 +1,4 @@
//! libc - Raw FFI bindings to platforms' system libraries
//!
//! [Documentation for other platforms][pd].
//!
//! [pd]: https://rust-lang.github.io/libc/#platform-specific-documentation
#![crate_name = "libc"]
#![crate_type = "rlib"]
#![allow(
Expand Down

0 comments on commit 14a7560

Please sign in to comment.