Merge pull request #19208 from ziglang/rework-autodoc

Redesign How Autodoc Works

Author: andrewrk

.github/CODEOWNERS

@@ -1,8 +1,3 @@
-# Autodoc
-/src/Autodoc.zig  @kristoff-it
-/src/autodoc/*    @kristoff-it
-/lib/docs/*       @kristoff-it
-
 # std.json
 /lib/std/json* @thejoshwolfe
 

.github/ISSUE_TEMPLATE/autodoc-issue.md

@@ -907,8 +907,6 @@ else()
 endif()
 
 # -Dno-langref is currently hardcoded because building the langref takes too damn long
-# -Dno-autodocs is currently hardcoded because the C backend generates a miscompilation
-#   that prevents it from working.
 # To obtain these two forms of documentation, run zig build against stage3 rather than stage2.
 set(ZIG_BUILD_ARGS
   --zig-lib-dir "${CMAKE_SOURCE_DIR}/lib"
@@ -918,7 +916,6 @@ set(ZIG_BUILD_ARGS
   ${ZIG_STATIC_ARG}
   ${ZIG_NO_LIB_ARG}
   "-Dno-langref"
-  "-Dno-autodocs"
   ${ZIG_SINGLE_THREADED_ARG}
   ${ZIG_PIE_ARG}
   "-Dtarget=${ZIG_TARGET_TRIPLE}"

CMakeLists.txt

@@ -31,7 +31,7 @@ pub fn build(b: *std.Build) !void {
     const test_step = b.step("test", "Run all the tests");
     const skip_install_lib_files = b.option(bool, "no-lib", "skip copying of lib/ files and langref to installation prefix. Useful for development") orelse false;
     const skip_install_langref = b.option(bool, "no-langref", "skip copying of langref to the installation prefix") orelse skip_install_lib_files;
-    const skip_install_autodocs = b.option(bool, "no-autodocs", "skip copying of standard library autodocs to the installation prefix") orelse skip_install_lib_files;
+    const std_docs = b.option(bool, "std-docs", "include standard library autodocs") orelse false;
     const no_bin = b.option(bool, "no-bin", "skip emitting compiler binary") orelse false;
 
     const docgen_exe = b.addExecutable(.{
@@ -55,17 +55,19 @@ pub fn build(b: *std.Build) !void {
         b.getInstallStep().dependOn(&install_langref.step);
     }
 
-    const autodoc_test = b.addTest(.{
+    const autodoc_test = b.addObject(.{
+        .name = "std",
         .root_source_file = .{ .path = "lib/std/std.zig" },
         .target = target,
         .zig_lib_dir = .{ .path = "lib" },
+        .optimize = .Debug,
     });
     const install_std_docs = b.addInstallDirectory(.{
         .source_dir = autodoc_test.getEmittedDocs(),
         .install_dir = .prefix,
         .install_subdir = "doc/std",
     });
-    if (!skip_install_autodocs) {
+    if (std_docs) {
         b.getInstallStep().dependOn(&install_std_docs.step);
     }