Skip to content

Commit

Permalink
add docgen tool; rename to docgen
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewrk committed Jun 6, 2024
1 parent f8e0382 commit 15c1421
Show file tree
Hide file tree
Showing 4 changed files with 1,085 additions and 10 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# doctest
# docgen

A tool for generating documents such as
[Zig's language reference](https://ziglang.org/documentation/0.12.0/) or
[release notes](https://ziglang.org/download/0.12.0/release-notes.html).

This repository is provided as a Zig package for convenience. The canonical
source lives
[in the zig compiler repository](https://github.com/ziglang/zig/blob/master/tools/doctest.zig).
source lives in the zig compiler repository:
* [doctest.zig](https://github.com/ziglang/zig/blob/master/tools/doctest.zig).
* [docgen.zig](https://github.com/ziglang/zig/blob/master/tools/docgen.zig).
30 changes: 23 additions & 7 deletions build.zig
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,39 @@ pub fn build(b: *std.Build) void {
const target = b.standardTargetOptions(.{});
const optimize = b.standardOptimizeOption(.{});

const exe = b.addExecutable(.{
const doctest_exe = b.addExecutable(.{
.name = "doctest",
.root_source_file = b.path("src/main.zig"),
.root_source_file = b.path("src/doctest.zig"),
.target = target,
.optimize = optimize,
});

b.installArtifact(exe);
const docgen_exe = b.addExecutable(.{
.name = "docgen",
.root_source_file = b.path("src/docgen.zig"),
.target = target,
.optimize = optimize,
});

b.installArtifact(doctest_exe);
b.installArtifact(docgen_exe);

const doctest_unit_tests = b.addTest(.{
.root_source_file = b.path("src/doctest.zig"),
.target = target,
.optimize = optimize,
});

const exe_unit_tests = b.addTest(.{
.root_source_file = b.path("src/main.zig"),
const docgen_unit_tests = b.addTest(.{
.root_source_file = b.path("src/docgen.zig"),
.target = target,
.optimize = optimize,
});

const run_exe_unit_tests = b.addRunArtifact(exe_unit_tests);
const run_doctest_unit_tests = b.addRunArtifact(doctest_unit_tests);
const run_docgen_unit_tests = b.addRunArtifact(docgen_unit_tests);

const test_step = b.step("test", "Run unit tests");
test_step.dependOn(&run_exe_unit_tests.step);
test_step.dependOn(&run_doctest_unit_tests.step);
test_step.dependOn(&run_docgen_unit_tests.step);
}
Loading

0 comments on commit 15c1421

Please sign in to comment.