Merge pull request #287 from gwbres/docrs

Introduce docrs
nyx-space · Aug 13, 2024 · 834c11b · 834c11b
2 parents d876a10 + 6ab58d7
commit 834c11b
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 5 deletions.
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -58,11 +58,13 @@ jobs:
         run: sh dev-env-setup.sh && cd .. # Return to root
 
       - name: Test debug
+        if: secrets.LAGRANGE_BSP != ''
         env:
           LAGRANGE_BSP: ${{ secrets.LAGRANGE_BSP }}
         run: cargo test --workspace --exclude anise-gui --exclude anise-py
 
       - name: Test release
+        if: secrets.LAGRANGE_BSP != ''
         env:
           LAGRANGE_BSP: ${{ secrets.LAGRANGE_BSP }}
         run: cargo test --release --workspace --exclude anise-gui --exclude anise-py
@@ -131,6 +133,7 @@ jobs:
         run: RUST_BACKTRACE=1 cargo test validate_hermite_type13_ --features spkezr_validation --release --workspace --exclude anise-gui --exclude anise-py -- --nocapture --include-ignored --test-threads 1
 
       - name: Rust-SPICE Lagrange validation
+        if: secrets.LAGRANGE_BSP != ''
         env:
           LAGRANGE_BSP: ${{ secrets.LAGRANGE_BSP }}
         run: RUST_BACKTRACE=1 cargo test validate_lagrange_type9_with_varying_segment_sizes --features spkezr_validation --release --workspace --exclude anise-gui --exclude anise-py -- --nocapture --include-ignored --test-threads 1
@@ -205,7 +208,7 @@ jobs:
           cargo llvm-cov test --no-report validate_jplde_de440s_no_aberration --features spkezr_validation -- --nocapture --ignored
           cargo llvm-cov test --no-report validate_jplde_de440s_aberration_lt --features spkezr_validation -- --nocapture --ignored
           cargo llvm-cov test --no-report validate_hermite_type13_from_gmat --features spkezr_validation -- --nocapture --ignored
-          cargo llvm-cov test --no-report validate_lagrange_type9_with_varying_segment_sizes --features spkezr_validation -- --nocapture --ignored
+          [ -n "$LAGRANGE_BSP" ] && cargo llvm-cov test --no-report validate_lagrange_type9_with_varying_segment_sizes --features spkezr_validation -- --nocapture --ignored
           cargo llvm-cov test --no-report ut_embed --features embed_ephem
           cargo llvm-cov report --lcov > ../lcov.txt
 

diff --git a/anise/Cargo.toml b/anise/Cargo.toml
@@ -9,9 +9,8 @@ repository = { workspace = true }
 description = "Core of the ANISE library"
 
 [package.metadata.docs.rs]
-features = [
-    "metaload",
-]
+all-features = true
+rustdoc-ars = ["--cfg", "docrs", "--generate-link-to-definition"]
 
 [dependencies]
 lexical-core = { workspace = true }

diff --git a/anise/src/almanac/embed.rs b/anise/src/almanac/embed.rs
@@ -16,7 +16,7 @@ struct AstroData;
 impl Almanac {
     /// Provides planetary ephemerides from 2024-01-01 until 2035-01-01. Also provides planetary constants data (from the PCK11 kernel).
     ///
-    /// Until https://github.com/nyx-space/anise/issues/269, this will provide 100 yeras of data
+    /// Until https://github.com/nyx-space/anise/issues/269, this will provide 100 years of data
     pub fn until_2035() -> AlmanacResult<Self> {
         // Regularly refer to https://github.com/nyx-space/anise/blob/master/data/ci_config.dhall for the latest CRC, although it should not change between minor versions!
         let pck11 = AstroData::get("pck11.pca").ok_or(AlmanacError::GenericError {

diff --git a/anise/src/almanac/mod.rs b/anise/src/almanac/mod.rs
@@ -48,6 +48,7 @@ pub mod metaload;
 mod python;
 
 #[cfg(feature = "embed_ephem")]
+#[cfg_attr(docrs, doc(cfg(feature = "embed_ephem")))]
 mod embed;
 
 #[cfg(feature = "python")]

diff --git a/anise/src/lib.rs b/anise/src/lib.rs
@@ -1,4 +1,5 @@
 #![doc = include_str!("../README.md")]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 /*
  * ANISE Toolkit
  * Copyright (C) 2021-onward Christopher Rabotin <[email protected]> et al. (cf. AUTHORS.md)