pkgs/tools/text/robodoc/default.nix

   1 { lib
   2 , stdenv
   3 , fetchFromGitHub
   4 , autoreconfHook
   5 }:
   6
   7 stdenv.mkDerivation rec {
   8   pname = "robodoc";
   9   version = "4.99.44";
  10
  11   src = fetchFromGitHub {
  12     owner = "gumpu";
  13     repo = "ROBODoc";
  14     rev = "v${version}";
  15     sha256 = "l3prSdaGhOvXmZfCPbsZJNocO7y20zJjLQpajRTJOqE=";
  16   };
  17
  18   nativeBuildInputs = [ autoreconfHook ];
  19
  20   hardeningDisable = [ "format" ];
  21
  22   meta = with lib; {
  23     homepage = "https://github.com/gumpu/ROBODoc";
  24     description = "Documentation Extraction Tool";
  25     longDescription = ''
  26       ROBODoc is program documentation tool. The idea is to include for every
  27       function or procedure a standard header containing all sorts of
  28       information about the procedure or function. ROBODoc extracts these
  29       headers from the source file and puts them in a separate
  30       autodocs-file. ROBODoc thus allows you to include the program
  31       documentation in the source code and avoid having to maintain two separate
  32       documents. Or as Petteri puts it: "robodoc is very useful - especially for
  33       programmers who don't like writing documents with Word or some other
  34       strange tool."
  35
  36       ROBODoc can format the headers in a number of different formats: HTML,
  37       RTF, LaTeX, or XML DocBook. In HTML mode it can generate cross links
  38       between headers. You can even include parts of your source code.
  39
  40       ROBODoc works with many programming languages: For instance C, Pascal,
  41       Shell Scripts, Assembler, COBOL, Occam, Postscript, Forth, Tcl/Tk, C++,
  42       Java -- basically any program in which you can use remarks/comments.
  43     '';
  44     license = with licenses; gpl3Plus;
  45     maintainers = with maintainers; [ AndersonTorres ];
  46     platforms = with platforms; all;
  47   };
  48 }