more

Author: fingolfin

src/index.md

@@ -16,7 +16,6 @@ JuliaDocs is the home for the following packages and repositories:
 * [DocInventories.jl -- Read and write documentation inventory files such as the objects.inv file generated by Documenter and Sphinx](https://github.com/JuliaDocs/DocInventories.jl)
 * [DocStringExtensions.jl -- Extensions for Julia's docsystem.](https://github.com/JuliaDocs/DocStringExtensions.jl)
 * [DocumentationGenerator.jl -- ](https://github.com/JuliaDocs/DocumentationGenerator.jl)
-* [DocumentationGeneratorRegistry -- ](https://github.com/JuliaDocs/DocumentationGeneratorRegistry)
 * [Documenter.jl -- A documentation generator for Julia.](https://github.com/JuliaDocs/Documenter.jl)
 * [DocumenterCitations.jl -- DocumenterCitations.jl uses Bibliography.jl to add support for BibTeX citations and references in documentation pages generated by Documenter.jl.](https://github.com/JuliaDocs/DocumenterCitations.jl)
 * [DocumenterInterLinks.jl -- A plugin for Documenter.jl that enables linking between projects](https://github.com/JuliaDocs/DocumenterInterLinks.jl)
@@ -106,15 +105,6 @@ PackageDefinition(
         "https://codecov.io/gh/JuliaDocs/DocumentationGenerator.jl/branch/master/graph/badge.svg" => "https://codecov.io/gh/JuliaDocs/DocumentationGenerator.jl",
     ]
 ),
-PackageDefinition(
-    "DocumentationGeneratorRegistry", "https://github.com/JuliaDocs/DocumentationGeneratorRegistry",
-    [
-        "README" => "https://github.com/JuliaDocs/DocumentationGeneratorRegistry",
-    ],
-    [
-        "https://codecov.io/gh/JuliaDocs/DocumentationGeneratorRegistry/branch/master/graph/badge.svg" => "https://codecov.io/gh/JuliaDocs/DocumentationGeneratorRegistry",
-    ]
-),
 PackageDefinition(
     "Documenter", "https://github.com/JuliaDocs/Documenter.jl",
     [

update.jl

@@ -1,16 +1,31 @@
+#
+# This script can regenerate index.md. You can run it via
+#
+#   julia --proj=. update.jl > src/index.md
+#
 using JSON
 
+# query information about all JuliaDocs repositories
 data = read(`gh repo list JuliaDocs --json "isArchived,description,homepageUrl,name,url,defaultBranchRef"`, String)
-
 repos = JSON.parse(data)
 
-# drop archived repositories
+# exclude archived repositories
 repos = filter!(x -> !x["isArchived"], repos)
 
-repos = filter!(x -> x["name"] != "juliadocs.github.io", repos)
+# exclude some other repostiroies
+excluded = [
+    "juliadocs.github.io",
+    "DocumentationGeneratorRegistry",
+]
+repos = filter!(x -> x["name"] ∉ excluded, repos)
 
+# sort alphabetical
 sort!(repos, by = x -> x["name"])
 
+
+# Now we print the index.md content. This just hardcoded a header and footer.
+# This is quick & dirty hack; a full template system might be nicer in theory,
+# but in practice this is good enough and dead simple.
 print("""
 # JuliaDocs
 
@@ -32,7 +47,7 @@ for r in repos
     println("* [$name -- $desc]($url)")
 end
 
-# TODO: should we linke to the homepage URL, if any, and provide the
+# TODO: should we link to the homepage URL, if any, and provide the
 # repository link separately, like it was done for the cheat sheet:
 #
 # * [Julia cheat sheet](https://cheatsheet.juliadocs.org/) ([repository](https://github.com/JuliaDocs/Julia-Cheat-Sheet))