clean up the loop a bit

Author: mortenpi

src/documentertools/canonical_urls.jl

@@ -93,28 +93,34 @@ function update_canonical_links(
     end
     canonical_full_root = joinurl(canonical, canonical_path...)
     # If we have determined which version should be the canonical version, we can actually
-    # go and run update_canonical_links_for_version on each directory.
-    for filename in readdir(docs_directory)
-        path = joinpath(docs_directory, filename)
+    # go and run update_canonical_links_for_version on each directory. First, we'll gather
+    # up the list of Documenter (or other) directories we actually want to run over.
+    docs_subdirectory_queue, docs_subdirectories = readdir(docs_directory), []
+    while !isempty(docs_subdirectory_queue)
+        docs_subdirectory = popfirst!(docs_subdirectory_queue)
+        path = joinpath(docs_directory, docs_subdirectory)
         # We'll skip all files. This includes files such as index.html, which in this
         # directory will likely be the redirect. Also, links should be pointing to other
         # versions, so we'll skip them too.
-        if islink(path) || !isdir(path)
+        if !isdir(path) || islink(path)
             continue
         end
-        # For true directories, we check that siteinfo.js file is present, which is a pretty
-        # good indicator that it's a proper Documenter build.
-        if !isfile(joinpath(path, "siteinfo.js"))
-            # We want to warn if we run across any directories that are not Documenter builds.
-            # But previews/ is one valid case which may be present and so we shouldn't warn
-            # for this one.
-            if filename != "previews"
-                @warn "update_canonical_links: skipping directory that does not look like a Documenter build" filename docs_directory
-            end
+        # Preview directory is should contain other Documenter directories, so we just add
+        # the subdirectories into the queue and ignore the parent directory itself
+        if docs_subdirectory == "previews"
+            append!(docs_subdirectory_queue, joinpath.(docs_subdirectory, readdir(path)))
             continue
         end
-        # Finally, we can run update_canonical_links_for_version on the directory.
-        @debug "Updating canonical URLs for version" docs_directory filename canonical_full_root
+        # For other directories, we check for the presence of siteinfo.js, and warn if that
+        # is missing (but we still try to go and update the canonical URLs).
+        if !isfile(joinpath(path, "siteinfo.js"))
+            @warn "update_canonical_links: missing siteinfo.js file" path
+        end
+        push!(docs_subdirectories, path)
+    end
+    # Finally, we can run update_canonical_links_for_version on the directory.
+    for path in docs_subdirectories
+        @debug "Updating canonical URLs for a version" path canonical_full_root
         update_canonical_links_for_version(path; canonical = canonical_full_root)
     end
 end

test/documentertools.jl

@@ -31,7 +31,7 @@ FIXTURES = joinpath(@__DIR__, "fixtures")
     let rs = DocumenterTools.walkdocs(joinpath(FIXTURES, "pre"), collect=true) do fileinfo
             fileinfo.root
         end
-        @test length(rs) == 5
+        @test length(rs) == 9
         @test all(s -> isa(s, String), rs)
     end
 end