nixpkgs/pkgs/development/tools/doc2go/default.nix
2023-08-09 21:59:01 +00:00

49 lines
1.2 KiB
Nix

{ lib
, buildGoModule
, fetchFromGitHub
}:
buildGoModule rec {
pname = "doc2go";
version = "0.5.0";
src = fetchFromGitHub {
owner = "abhinav";
repo = "doc2go";
rev = "v${version}";
hash = "sha256-CFqr1laPxKNhaluGmwW7apxLQqkAFKVznDKezH8gjx0=";
};
vendorHash = "sha256-2WvlH69iYqIA3d9aFVec8TZL+pMJItoNKSoDBL/NNyg=";
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 ];
};
}