From e56e646c3c672daaf39d3ce7676acbbbfc4e0d84 Mon Sep 17 00:00:00 2001
From: Matthijs Brobbel <m1brobbel@gmail.com>
Date: Wed, 10 Jul 2024 09:41:51 +0200
Subject: [PATCH] docs: `--cfg=docsrs` is now a default set by docs.rs (#190)

It's no longer required to specify this in our package metadata.
---
 .github/workflows/docs.yml        | 19 +++++--------------
 CONTRIBUTING.md                   |  6 ++++++
 Cargo.toml                        |  1 -
 src/parse/proto/extensions/mod.rs |  2 +-
 src/proto.rs                      |  3 ++-
 5 files changed, 14 insertions(+), 17 deletions(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 949fd3d..a6b69b0 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -16,6 +16,8 @@ jobs:
   rustdoc:
     name: Rustdoc
     runs-on: ubuntu-latest
+    env:
+      RUSTDOCFLAGS: -Dwarnings
     steps:
       - uses: actions/checkout@v4
         with:
@@ -23,20 +25,9 @@ jobs:
           submodules: recursive
       - uses: dtolnay/rust-toolchain@nightly
         id: rust-toolchain
-      - uses: actions/cache@v4
-        with:
-          path: |
-            ~/.cargo/bin/
-            ~/.cargo/registry/index/
-            ~/.cargo/registry/cache/
-            ~/.cargo/git/db/
-            target/
-          key: ${{ runner.os }}-cargo-${{ steps.rust-toolchain.outputs.cachekey }}-rustdoc-${{ hashFiles('**/Cargo.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-cargo-${{ steps.rust-toolchain.outputs.cachekey }}-rustdoc-
-            ${{ runner.os }}-cargo-${{ steps.rust-toolchain.outputs.cachekey }}-
-            ${{ runner.os }}-cargo-
-      - run: cargo rustdoc --all-features -- --cfg docsrs
+      - uses: dtolnay/install@cargo-docs-rs
+      - run: cargo docs-rs
+      - run: mv "target/$(rustc -vV | awk '/^host/ { print $2 }')/doc" "target/doc"
       - run: chmod -c -R +rX "target/doc"
       - run: echo "<meta http-equiv=refresh content=0;url=substrait>" > target/doc/index.html
       - if: github.event_name == 'push' && github.ref == 'refs/heads/main'
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 854d517..47708b3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -87,6 +87,12 @@ Or to enable automatic feature information (requires a nightly toolchain):
 cargo +nightly rustdoc -- --cfg docsrs
 ```
 
+Or use [cargo-doc-rs](https://crates.io/crates/cargo-docs-rs):
+
+```
+cargo +nightly docs-rs
+```
+
 ### Formatting
 
 All Rust code is formatted using [rustfmt](https://github.com/rust-lang/rustfmt):
diff --git a/Cargo.toml b/Cargo.toml
index f5b38fc..d089833 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -61,4 +61,3 @@ walkdir = "2.5.0"
 
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/src/parse/proto/extensions/mod.rs b/src/parse/proto/extensions/mod.rs
index 2527805..66d2bdb 100644
--- a/src/parse/proto/extensions/mod.rs
+++ b/src/parse/proto/extensions/mod.rs
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
-//! Parsing of [proto::extensions] types.
+//! Parsing of [crate::proto::extensions] types.
 
 mod simple_extension_uri;
 pub use simple_extension_uri::SimpleExtensionUri;
diff --git a/src/proto.rs b/src/proto.rs
index f5631a3..ee32bd3 100644
--- a/src/proto.rs
+++ b/src/proto.rs
@@ -3,7 +3,8 @@
 #![allow(
     clippy::large_enum_variant,
     clippy::needless_borrow,
-    clippy::needless_borrows_for_generic_args
+    clippy::needless_borrows_for_generic_args,
+    rustdoc::invalid_html_tags
 )]
 
 //! Generated types for the protobuf `substrait` package.