paritytech · liamaharon · Apr 4, 2024 · Mar 28, 2024 · Mar 28, 2024 · Mar 28, 2024
@@ -91,16 +91,15 @@ build-rustdoc:
     - .run-immediately
   variables:
     SKIP_WASM_BUILD: 1
-    RUSTDOCFLAGS: "--default-theme=ayu --html-in-header ./docs/sdk/headers/header.html --extend-css ./docs/sdk/headers/theme.css"
+    RUSTDOCFLAGS: "-Dwarnings --default-theme=ayu --html-in-header ./docs/sdk/assets/header.html --extend-css ./docs/sdk/assets/theme.css --html-after-content ./docs/sdk/assets/after-content.html"
   artifacts:
     name: "${CI_JOB_NAME}_${CI_COMMIT_REF_NAME}-doc"
     when: on_success
     expire_in: 1 days
     paths:
       - ./crate-docs/
   script:
-    # FIXME: it fails with `RUSTDOCFLAGS="-Dwarnings"` and `--all-features`
-    - time cargo doc --features try-runtime,experimental --workspace --no-deps
+    - time cargo doc --all-features --workspace --no-deps
     - rm -f ./target/doc/.lock
     - mv ./target/doc ./crate-docs
     # Inject Simple Analytics (https://www.simpleanalytics.com/) privacy preserving tracker into

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/cumulus/test/service/src/chain_spec.rs b/cumulus/test/service/src/chain_spec.rs
@@ -34,7 +34,7 @@ pub fn get_from_seed<TPublic: Public>(seed: &str) -> <TPublic::Pair as Pair>::Pu
 		.public()
 }
 
-/// The extensions for the [`ChainSpec`](crate::ChainSpec).
+/// The extensions for the [`ChainSpec`].
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ChainSpecGroup, ChainSpecExtension)]
 #[serde(deny_unknown_fields)]
 pub struct Extensions {

diff --git a/docs/sdk/assets/after-content.html b/docs/sdk/assets/after-content.html
@@ -0,0 +1,2 @@
+<script> mermaid.init({ startOnLoad: true, theme: "dark" }, "pre.language-mermaid > code");</script>
+
diff --git a/docs/sdk/headers/header.html → docs/sdk/assets/header.html b/docs/sdk/headers/header.html → docs/sdk/assets/header.html
@@ -84,6 +84,8 @@
 	});
 </script>
 
+<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
+
 <style>
 	body.sdk-docs {
 		nav.side-bar {

diff --git a/docs/sdk/headers/theme.css → docs/sdk/assets/theme.css b/docs/sdk/headers/theme.css → docs/sdk/assets/theme.css
diff --git a/prdoc/pr_3875.prdoc b/prdoc/pr_3875.prdoc
@@ -0,0 +1,11 @@
+# Schema: Polkadot SDK PRDoc Schema (prdoc) v1.0.0
+# See doc at https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/prdoc/schema_user.json
+
+title: Fix Mermaid diagram rendering
+
+doc:
+  - audience: Runtime Dev
+    description: |
+      Fixes the rendering of some Mermaid diagrams in the documentation.
+
+crates: [ ]
diff --git a/substrate/frame/bags-list/Cargo.toml b/substrate/frame/bags-list/Cargo.toml
@@ -35,7 +35,6 @@ frame-election-provider-support = { path = "../election-provider-support", defau
 # third party
 log = { workspace = true }
 docify = "0.2.7"
-aquamarine = { version = "0.5.0" }
 
 # Optional imports for benchmarking
 frame-benchmarking = { path = "../benchmarking", default-features = false, optional = true }

diff --git a/substrate/frame/bags-list/src/lib.rs b/substrate/frame/bags-list/src/lib.rs
@@ -85,7 +85,6 @@
 #![cfg_attr(not(feature = "std"), no_std)]
 
 #[cfg(doc)]
-#[cfg_attr(doc, aquamarine::aquamarine)]
 ///
 /// In this example, assuming each node has an equal id and score (eg. node 21 has a score of 21),
 /// the node 22 can be moved from bag 1 to bag 0 with the `rebag` operation.

diff --git a/substrate/frame/executive/Cargo.toml b/substrate/frame/executive/Cargo.toml
@@ -16,7 +16,6 @@ workspace = true
 targets = ["x86_64-unknown-linux-gnu"]
 
 [dependencies]
-aquamarine = "0.3.2"
 codec = { package = "parity-scale-codec", version = "3.6.1", default-features = false, features = [
 	"derive",
 ] }

diff --git a/substrate/frame/executive/src/lib.rs b/substrate/frame/executive/src/lib.rs
@@ -119,7 +119,6 @@
 //! ```
 
 #[cfg(doc)]
-#[cfg_attr(doc, aquamarine::aquamarine)]
 /// # Block Execution
 ///
 /// These are the steps of block execution as done by [`Executive::execute_block`]. A block is

diff --git a/substrate/frame/support/Cargo.toml b/substrate/frame/support/Cargo.toml
@@ -61,8 +61,6 @@ serde_json = { features = ["alloc"], workspace = true }
 docify = "0.2.7"
 static_assertions = "1.1.0"
 
-aquamarine = { version = "0.5.0" }
-
 [dev-dependencies]
 assert_matches = "1.3.0"
 pretty_assertions = "1.2.1"

diff --git a/substrate/frame/support/src/traits/hooks.rs b/substrate/frame/support/src/traits/hooks.rs
@@ -318,7 +318,6 @@ pub trait IntegrityTest {
 	fn integrity_test() {}
 }
 
-#[cfg_attr(doc, aquamarine::aquamarine)]
 /// The pallet hooks trait. This is merely an umbrella trait for:
 ///
 /// - [`OnInitialize`]
@@ -370,16 +369,16 @@ pub trait IntegrityTest {
 /// end
 /// ```
 ///
-/// * [`OnRuntimeUpgrade`](Hooks::OnRuntimeUpgrade) hooks are only executed when a code change is
-///   detected.
-/// * [`OnRuntimeUpgrade`](Hooks::OnRuntimeUpgrade) hooks are mandatorily executed at the very
-///   beginning of the block body, before any extrinsics are processed.
+/// * [`OnRuntimeUpgrade`](crate::traits::OnRuntimeUpgrade) hooks are only executed when a code
+///   change is detected.
+/// * [`OnRuntimeUpgrade`](crate::traits::OnRuntimeUpgrade) hooks are mandatorily executed at the
+///   very beginning of the block body, before any extrinsics are processed.
 /// * [`Inherents`](sp_inherents) are always executed before any other other signed or unsigned
 ///   extrinsics.
-/// * [`OnIdle`](Hooks::OnIdle) hooks are executed after extrinsics if there is weight remaining in
-///   the block.
-/// * [`OnFinalize`](Hooks::OnFinalize) hooks are mandatorily executed after
-///   [`OnIdle`](Hooks::OnIdle).
+/// * [`OnIdle`](crate::traits::OnIdle) hooks are executed after extrinsics if there is weight
+///   remaining in the block.
+/// * [`OnFinalize`](crate::traits::OnFinalize) hooks are mandatorily executed after
+///   [`OnIdle`](crate::traits::OnIdle).
 ///
 /// > [`OffchainWorker`](crate::traits::misc::OffchainWorker) hooks are not part of this flow,
 /// > because they are not part of the consensus/main block building logic. See