Get intralink information from rustdoc.

Author: orium

.github/workflows/ci.yml

@@ -9,6 +9,7 @@ on:
     - cron: '0 19 * * 3'
 
 env:
+  MIRI_TOOLCHAIN: nightly-2026-01-24
   CARGO_TERM_COLOR: always
 
 jobs:
@@ -20,12 +21,22 @@ jobs:
         os: [ubuntu-latest, macos-latest, windows-latest]
 
     steps:
-      - name: Install rust
+      - name: Install rust (stable)
         uses: dtolnay/rust-toolchain@stable
         with:
-          # We need to install the source of the standard library for the integration tests to check that links
-          # to the standard library are correctly generated.
-          components: rust-src, rustfmt
+          components: rustfmt
+
+      # TODO Use stable when this stabilizes (https://github.com/rust-lang/rust/issues/76578).
+      # We need to install rust nightly to run the integration tests: nightly is needed to get the rustdoc information
+      # for intralinks. This will not be needed once that feature stabilizes
+      # (https://github.com/rust-lang/rust/issues/76578).
+      - name: Install rust (nightly)
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: ${{ env.INTRALINKS_TOOLCHAIN }}
+
+      - name: Use stable rust for the build
+        run: rustup default stable
 
       - name: Install cargo plugins
         run: |

Cargo.lock

@@ -39,6 +39,10 @@ git2 = { version = "0.20.3", default-features = false }
 indoc = "2.0.7"
 itertools = "0.14.0"
 pulldown-cmark = "0.13.0"
+rustdoc-json = "0.9.8"
+rustdoc-types = "0.57.0"
+rustup-toolchain = "0.1.10"
+serde_json = "1.0.149"
 syn = { version = "2.0.114", features = ["full", "extra-traits"] }
 termcolor = "1.4.1"
 thiserror = "2.0.18"

Cargo.toml

@@ -203,6 +203,13 @@ docs-rs-base-url = "https://mydocs.rs"
 docs-rs-version = "1.0.0"
 # If this is set the intralinks will be stripping in the README file.
 strip-links = false
+
+# Enable all features when calling rustdoc to resolve intralinks.
+all-features = true
+# Features to enable when calling rustdoc to resolve intralinks.
+features = ["foo", "bar"]
+# Disable default features when calling rustdoc to resolve intralinks.
+no-default-features = false
 ```
 
 These setting can be overridden with command line flags. Run `cargo rdme --help` for more

README.md

@@ -6,7 +6,7 @@ use termcolor::{ColorSpec, StandardStream};
 
 pub use termcolor::Color;
 
-fn is_stderr_terminal() -> bool {
+pub fn is_stderr_terminal() -> bool {
     std::io::stderr().is_terminal()
 }
 

src/console.rs

@@ -40,9 +40,16 @@ pub fn find_first_file_in_ancestors(dir_path: impl AsRef<Path>, filename: &str)
     None
 }
 
+#[derive(Debug)]
+pub enum PackageTarget {
+    Bin { crate_name: String },
+    Lib,
+}
+
 #[derive(PartialEq, Eq, Debug)]
 pub struct Project {
     package_name: PackageName,
+    manifest_path: PathBuf,
     readme_path: Option<PathBuf>,
     lib_path: Option<PathBuf>,
     bin_path: HashMap<String, PathBuf>,
@@ -114,16 +121,16 @@ impl Project {
         let bin_packages =
             package.targets.iter().filter(|target| target.kind.contains(&TargetKind::Bin));
 
-        let directory = package
-            .manifest_path
-            .clone()
-            .into_std_path_buf()
+        let manifest_path = package.manifest_path.clone().into_std_path_buf();
+
+        let directory = manifest_path
             .parent()
             .expect("error getting the parent path of the manifest file")
             .to_path_buf();
 
         Project {
             package_name: package.name.clone(),
+            manifest_path,
             readme_path: package.readme.as_ref().map(|p| p.clone().into_std_path_buf()),
             lib_path: lib_package.map(|t| t.src_path.clone().into_std_path_buf()),
             bin_path: bin_packages
@@ -138,6 +145,14 @@ impl Project {
         self.lib_path.as_ref().filter(|p| p.is_file()).map(PathBuf::as_path)
     }
 
+    #[must_use]
+    pub fn get_bin_default_crate_name(&self) -> Option<&str> {
+        match self.bin_path.len() {
+            1 => self.bin_path.keys().next().map(String::as_str),
+            _ => None,
+        }
+    }
+
     #[must_use]
     pub fn get_bin_default_entryfile_path(&self) -> Option<&Path> {
         match self.bin_path.len() {
@@ -168,15 +183,11 @@ impl Project {
     pub fn get_package_name(&self) -> &PackageName {
         &self.package_name
     }
-}
 
-fn project_package_name(manifest_path: impl AsRef<Path>) -> Option<String> {
-    let str: String = std::fs::read_to_string(&manifest_path).ok()?;
-    let toml: toml::Value = toml::from_str(&str).ok()?;
-    let package_name =
-        toml.get("package").and_then(|v| v.get("name")).and_then(toml::Value::as_str)?;
-
-    Some(package_name.to_owned())
+    #[must_use]
+    pub fn get_manifest_path(&self) -> &PathBuf {
+        &self.manifest_path
+    }
 }
 
 #[derive(Eq, PartialEq, Clone, Debug)]