fix(ci): move rustdoc to nightly + deny warnings

This compiles the repo on release, which will always not utilize cache
and slow down PRs unnecessarily. Also, docs are only important before
a release.

Also fixed warnings.

Note: currently nightly fails on a bug in coverage, will be fixed
separately.

TODO: add notifications on nightly failures.

.github/workflows/main.yml

@@ -68,9 +68,6 @@ jobs:
       - name: "Run clippy pull request"
         if: github.event_name == 'pull_request'
         run: ci/bin/python scripts/run_tests.py --command clippy --changes_only --commit_id ${{ github.event.pull_request.base.sha }}
-      - name: "Run cargo doc pull request"
-        if: github.event_name == 'pull_request'
-        run: ci/bin/python scripts/run_tests.py --command doc --changes_only --commit_id ${{ github.event.pull_request.base.sha }}
 
       # Run code style on push.
       - name: "Run rustfmt on push"
@@ -79,9 +76,6 @@ jobs:
       - name: "Run clippy on push"
         if: github.event_name == 'push'
         run: ci/bin/python scripts/run_tests.py --command clippy
-      - name: "Run cargo doc on push"
-        if: github.event_name == 'push'
-        run: ci/bin/python scripts/run_tests.py --command doc
 
       - name: "Run taplo"
         run: scripts/taplo.sh

.github/workflows/main_nightly.yml

@@ -54,4 +54,17 @@ jobs:
           fail_ci_if_error: true
           version: "v0.1.15"
 
+  rustdoc:
+      runs-on: starkware-ubuntu-latest-large
+      steps:
+        - uses: actions/checkout@v4
+          with:
+            fetch-depth: 0
+        - uses: ./.github/actions/bootstrap
+
+        - name: Build Documentation
+          run: cargo doc --all --no-deps -r --document-private-items
+          env:
+            # Note that cargo doc requires RUSTDOCFLAGS, not RUSTFLAGS.
+            RUSTDOCFLAGS: ${{ env.RUSTFLAGS }}
 

crates/blockifier/src/execution/syscalls/mod.rs

@@ -343,8 +343,8 @@ impl SyscallResponse for GetBlockHashResponse {
 
 /// Returns the block hash of a given block_number.
 /// Returns the expected block hash if the given block was created at least
-/// [constants::STORED_BLOCK_HASH_BUFFER] blocks before the current block. Otherwise, returns an
-/// error.
+/// [crate::abi::constants::STORED_BLOCK_HASH_BUFFER] blocks before the current block. Otherwise,
+/// returns an error.
 pub fn get_block_hash(
     request: GetBlockHashRequest,
     _vm: &mut VirtualMachine,

crates/starknet_api/src/state.rs

@@ -247,7 +247,7 @@ impl From<cairo_lang_starknet_classes::contract_class::ContractClass> for Sierra
     }
 }
 
-/// An entry point of a [ContractClass](`crate::state::ContractClass`).
+/// An entry point of a [SierraContractClass](`SierraContractClass`).
 #[derive(Debug, Default, Clone, Eq, PartialEq, Hash, Deserialize, Serialize, PartialOrd, Ord)]
 pub struct EntryPoint {
     pub function_idx: FunctionIndex,

crates/starknet_sequencer_node/src/clients.rs

@@ -64,8 +64,8 @@ pub struct SequencerNodeClients {
 ///
 /// # Returns
 ///
-/// An Option<Arc<dyn ClientTrait>> containing the available client (local_client or remote_client),
-/// wrapped in Arc. If neither exists, returns None.
+/// An `Option<Arc<dyn ClientTrait>>` containing the available client (local_client or
+/// remote_client), wrapped in Arc. If neither exists, returns None.
 ///
 /// # Example
 ///