From 7796d4c32cb2af397c3a0b3a6603cac585b6341d Mon Sep 17 00:00:00 2001 From: 06kellyjac Date: Wed, 19 Jul 2023 15:53:24 +0100 Subject: [PATCH] doc2go: init at 0.4.1 --- pkgs/development/tools/doc2go/default.nix | 49 +++++++++++++++++++++++ pkgs/top-level/all-packages.nix | 2 + 2 files changed, 51 insertions(+) create mode 100644 pkgs/development/tools/doc2go/default.nix diff --git a/pkgs/development/tools/doc2go/default.nix b/pkgs/development/tools/doc2go/default.nix new file mode 100644 index 000000000000..0635c7ba1040 --- /dev/null +++ b/pkgs/development/tools/doc2go/default.nix @@ -0,0 +1,49 @@ +{ lib +, buildGoModule +, fetchFromGitHub +}: + +buildGoModule rec { + pname = "doc2go"; + version = "0.4.1"; + + src = fetchFromGitHub { + owner = "abhinav"; + repo = "doc2go"; + rev = "v${version}"; + hash = "sha256-iypcjj6FFsus9mrafLBX0u7bHnzs718aEWC5dO3q0es="; + }; + vendorHash = "sha256-IMqYCVGsspYigTmYNHD1b6Sgzxl47cdiCs+rq4C3Y08="; + + ldflags = [ "-s" "-w" "-X main._version=${version}" ]; + + subPackages = [ "." ]; + + checkFlags = [ + # needs to fetch additional go modules + "-skip=TestFinder_ImportedPackage/Modules" + ]; + + preCheck = '' + # run all tests + unset subPackages + ''; + + meta = with lib; { + homepage = "https://github.com/abhinav/doc2go"; + changelog = "https://github.com/abhinav/doc2go/blob/${src.rev}/CHANGELOG.md"; + description = "Your Go project's documentation, to-go"; + longDescription = '' + doc2go is a command line tool that generates static HTML documentation + from your Go code. It is a self-hosted static alternative to + https://pkg.go.dev/ and https://godocs.io/. + ''; + license = with licenses; [ + # general project license + asl20 + # internal/godoc/synopsis*.go adapted from golang source + bsd3 + ]; + maintainers = with maintainers; [ jk ]; + }; +} diff --git a/pkgs/top-level/all-packages.nix b/pkgs/top-level/all-packages.nix index 682cee5a8dab..b6c453c55fe5 100644 --- a/pkgs/top-level/all-packages.nix +++ b/pkgs/top-level/all-packages.nix @@ -800,6 +800,8 @@ with pkgs; docker-slim = callPackage ../applications/virtualization/docker-slim { }; + doc2go = callPackage ../development/tools/doc2go { }; + docker-sync = callPackage ../tools/misc/docker-sync { }; undocker = callPackage ../tools/misc/undocker { };