Skip to content

Guard docs Literate generation when examples/ is absent#205

Merged
lukem12345 merged 2 commits into
mainfrom
copilot/fix-failing-docs-build
May 3, 2026
Merged

Guard docs Literate generation when examples/ is absent#205
lukem12345 merged 2 commits into
mainfrom
copilot/fix-failing-docs-build

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 3, 2026

The docs workflow failed in CI after dependency updates because docs/make.jl unconditionally walked ../examples, which is not present in this repository layout. This caused an ENOENT before makedocs could run.

  • Docs build robustness

    • Added a filesystem guard around Literate example discovery/generation in docs/make.jl.
    • Docs now continue building when examples/ is missing, instead of erroring during walkdir.
  • Behavioral change

    • Example notebooks/markdown are generated only when docs/../examples exists.
    • When absent, the build logs an info message and proceeds with normal Documenter output.
  • Minimal implementation

    if isdir(literate_dir)
      for (root, dirs, files) in walkdir(literate_dir)
        # existing Literate.markdown / Literate.notebook generation
      end
    else
      @info "Skipping Literate examples generation because examples directory is missing" literate_dir
    end

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/repos/AlgebraicJulia/AlgebraicInterfaces.jl/tarball/28cca88bde1068ccf57f950e639df67975517c25
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/Expat_jll.jl/tarball/8f05e9a2e7c2e3eb524102bb2926c5743c07fbe1
    • Triggering command: /usr/bin/julia julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate() (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/Git_LFS_jll.jl/tarball/bb8471f313ed941f299aa53d32a94ab3bee08844
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/Git_jll.jl/tarball/0dd4cfb426924210c8f42742751cbde74b27bfa3
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/Libiconv_jll.jl/tarball/be484f5c92fad0bd8acfef35fe017900b0b73809
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/MbedTLS_jll.jl/tarball/ff69a2b1330bcb730b9ac1ab7dd680176f5896b8
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaBinaryWrappers/OpenSSH_jll.jl/tarball/57baa4b81a24c2910afbb6d853aa0685e4312bf7
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaCollections/AbstractTrees.jl/tarball/2d9c9a55f9c93e8887ad391fbae72f8ef55e1177
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaCollections/DataStructures.jl/tarball/4e1fe97fdaed23e9dc21d4d664bea76b65fc50a0
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaCollections/OrderedCollections.jl/tarball/05868e21324cede2207c6f0f466b4bfef6d5e7ee
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.test() (http block)
  • https://api.github.com/repos/JuliaData/Parsers.jl/tarball/5d5e0a78e971354b1c7bff0655d11fdc1b0e12c8
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.test() (http block)
  • https://api.github.com/repos/JuliaDocs/ANSIColoredPrinters.jl/tarball/574baf8110975760d391c710b6341da1afa48d8c
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaDocs/DocStringExtensions.jl/tarball/7442a5dfe1ebb773c29cc2962a8980f47221d76c
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaDocs/Documenter.jl/tarball/56e9c37b5e7c3b4f080ab1da18d72d5c290e184a
    • Triggering command: /usr/bin/julia julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate() (http block)
  • https://api.github.com/repos/JuliaDocs/IOCapture.jl/tarball/0ee181ec08df7d7c911901ea38baf16f755114dc
    • Triggering command: /usr/bin/julia julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate() (http block)
  • https://api.github.com/repos/JuliaDocs/LiveServer.jl/tarball/9f65b8a9989e6acb6e216785dd0c748d9569fc9b
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaDocs/MarkdownAST.jl/tarball/93c718d892e73931841089cdc0e982d6dd9cc87b
    • Triggering command: /usr/bin/julia julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate() (http block)
  • https://api.github.com/repos/JuliaGraphics/ColorTypes.jl/tarball/67e11ee83a43eb71ddc950302c53bf33f0690dfe
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.test() (http block)
  • https://api.github.com/repos/JuliaGraphics/Colors.jl/tarball/37ea44092930b1811e666c3bc38065d7d87fcc74
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.test() (http block)
  • https://api.github.com/repos/JuliaIO/CodecZlib.jl/tarball/962834c22b66e32aa10f7611c08c8ca4e20749a9
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaIO/JSON.jl/tarball/31e996f0a15c7b280ba9f76636b3ff9e2ae58c9a
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaIO/TranscodingStreams.jl/tarball/0c45878dcfdcfa8480052b6ab162cdd138781742
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaLang/Compat.jl/tarball/9d8a54ce4b17aa5bdce0ea5c34bc5e7c340d16ad
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.test() (http block)
  • https://api.github.com/repos/JuliaLang/MbedTLS.jl/tarball/8785729fa736197687541f7053f6d8ab7fc44f92
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaLang/PrecompileTools.jl/tarball/07a921781cab75691315adc645096ed5e370cb77
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaLogging/LoggingExtras.jl/tarball/f00544d95982ea270145636c181ceda21c4e2575
    • Triggering command: /usr/bin/julia julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate() (http block)
  • https://api.github.com/repos/JuliaMath/FixedPointNumbers.jl/tarball/05882d6995ae5c12bb5f36dd2ed3f61c98cbb172
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaPackaging/JLLWrappers.jl/tarball/0533e564aae234aff59ab625543145446d8b6ec2
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaPackaging/Preferences.jl/tarball/8b770b60760d4451834fe79dd483e318eee709c4
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaPackaging/SimpleBufferStream.jl/tarball/f305871d2f381d21527c770d4788c06c097c9bc1
    • Triggering command: /usr/bin/julia julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate() (http block)
  • https://api.github.com/repos/JuliaRegistries/RegistryInstances.jl/tarball/ffd19052caf598b8653b99404058fce14828be51
    • Triggering command: /usr/bin/julia julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate() (http block)
  • https://api.github.com/repos/JuliaServices/ConcurrentUtilities.jl/tarball/21d088c496ea22914fe80906eb5bce65755e5ec8
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaServices/ExceptionUnwrapping.jl/tarball/d36f682e590a83d63d1c7dbd287573764682d12a
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaStats/Statistics.jl/tarball/ae3bb1eb3bba077cd276bc5cfc337cc65c3075c0
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaVersionControl/Git.jl/tarball/824a1890086880696fc908fe12a17bcf61738bd8
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaWeb/HTTP.jl/tarball/51059d23c8bb67911a2e6fd5130229113735fc7e
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaWeb/MIMEs.jl/tarball/65f28ad4b594aebe22157d6fac869786a255b7eb
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaWeb/OpenSSL.jl/tarball/1d1aaa7d449b58415f97d2839c318b70ffb525a0
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/JuliaWeb/URIs.jl/tarball/bef26fb046d031353ef97a82e3fdb6afe7f21b1a
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/KristofferC/Crayons.jl/tarball/249fe38abf76d48563e2f4556bebd215aa317e15
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.test() (http block)
  • https://api.github.com/repos/KristofferC/LazilyInitializedFields.jl/tarball/0f2da712350b020bc3957f269c9caad516383ee0
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/fredrikekre/Literate.jl/tarball/bb26d8b8ed0fa451ce3511e99c950653a2f31fe1
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/jmert/BitFlags.jl/tarball/0691e34b3bb8be9307330f88d1a3c3f25466c24d
    • Triggering command: /usr/bin/julia julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate() (http block)
  • https://api.github.com/repos/jolin-io/StructEquality.jl/tarball/192a9f1de3cfef80ab1a4ba7b150bb0e11ceedcf
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.test() (http block)
  • https://api.github.com/repos/simonster/Reexport.jl/tarball/45e428421666073eab6f2da5c9d310d99bb12f9b
    • Triggering command: REDACTED, pid is -1 (http block)
  • https://api.github.com/repos/thautwarm/MLStyle.jl/tarball/bc38dff0548128765760c79eb7388a4b37fae2c8
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.test() (http block)
  • pkg.julialang.org
    • Triggering command: /usr/bin/julia julia --project -e using Pkg; Pkg.test() (dns block)
    • Triggering command: /usr/bin/julia julia --project=docs -e using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate() (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI linked an issue May 3, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Fix failing docs build due to missing directory Guard docs Literate generation when examples/ is absent May 3, 2026
Copilot AI requested a review from lukem12345 May 3, 2026 15:48
@lukem12345 lukem12345 marked this pull request as ready for review May 3, 2026 15:50
Copilot stopped work on behalf of lukem12345 due to an error May 3, 2026 15:57
@lukem12345
Copy link
Copy Markdown
Member

5aad899 is apparently when the examples directory was removed. Old action logs will likely be missing; I assume that this failing docs action is hopefully redundant due to a buildkite action, but the buildkite action is down on main apparently. I'm merging this, and will resolve warnings on the docs build in a follow-up PR.

@lukem12345 lukem12345 merged commit 6e669fb into main May 3, 2026
9 of 11 checks passed
@lukem12345 lukem12345 deleted the copilot/fix-failing-docs-build branch May 3, 2026 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Failing docs build

2 participants