Merge pull request #12 from Yarwin/supply-published-docs-cfg

Include `published_docs` cfg while building the docs.

Author: Bromeon

.github/workflows/build-website.yml

@@ -25,7 +25,7 @@ permissions:
 
 jobs:
   check-website:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     if: github.event_name == 'pull_request'
     steps:
       - name: "Checkout"
@@ -40,7 +40,7 @@ jobs:
 
 
   deploy-website:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     if: github.event_name != 'pull_request'
     steps:
       - name: "Workflow triggered by push to master"
@@ -133,7 +133,7 @@ jobs:
   license-guard:
     # not on repo dispatch
     if: github.event_name != 'repository_dispatch'
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
 

.github/workflows/garbage-collect.yml

@@ -18,7 +18,7 @@ defaults:
 
 jobs:
   remove-closed-prs:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - name: "Checkout"
         uses: actions/checkout@v4

.github/workflows/update-docs.yml

@@ -27,7 +27,7 @@ defaults:
 
 jobs:
   update-docs:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
 #      - name: "Info about workflow (${{ github.event.client_payload.op }} ${{ github.event.client_payload.repo }}/${{ github.event.client_payload.num }})"
       - name: "Info about workflow (${{ env.OP }} ${{ env.REPO }}/${{ env.NUM }})"

documentation/put.sh

@@ -92,7 +92,10 @@ up=".."
 
 # unused_doc_comments,unused_attribute: caused by false positives from doc(cfg(...)) attributes.
 export RUSTFLAGS="--cfg published_docs -A unused_imports -A dead_code -A unexpected_cfgs -A unused_doc_comments -A unused_attributes"
-# export RUSTDOCFLAGS=...
+# Both need to be supplied since `RUSTDOCFLAGS` is being propagated only to crate that is being documented (only "godot" crate in this case)
+# while we need cfg value `published_docs` for codegen and other crates as well.
+# All doc(cfg(...)) attributes are gated behind `published_docs` cfg – therefore it must be supplied as well.
+export RUSTDOCFLAGS=$RUSTFLAGS
 
 # shellcheck disable=SC2086
 cargo +nightly doc -p $mainCrate $features --no-deps --target-dir $up/target