Merge pull request #77 from afh/improve-web-docs

Improve docs by using mandoc and adding txt versions

Author: afh

.github/workflows/build_and_deploy.yml

@@ -29,9 +29,9 @@ jobs:
         run: |
           mkdir -p build/doc
           nix build .#doc-ledger
-          cp result/share/doc/ledger/ledger* build/doc
+          cp result/share/doc/ledger/ledger* build/doc/
           nix build .#doc-ledger-mode
-          cp result/ledger-mode.* build/doc
+          cp result/ledger-mode.* build/doc/
           nix build .#doc-ledger-api
           cp -R result/share/doc/ledger/html build/doc/api/
       - name: Upload artifact

flake.lock

@@ -87,7 +87,7 @@
          src = ledger;
 
          nativeBuildInputs = with pkgs; [
-           cmake groff ghostscript texinfo tex
+           cmake mandoc ghostscript texinfo tex
          ];
 
          enableParallelBuilding = false;
@@ -99,16 +99,9 @@
          buildFlags = "doc";
 
          postBuild = ''
-           # Create print version of ledger manpage
-           pdfroff -man -dpaper=letter -P-pletter $src/doc/ledger.1 > ledger.1.pdf
            # Patch web version of ledger manual to support dark mode
            sed -e 's@</style>@&\n<link rel="stylesheet" type="text/css" href="https://www.gnu.org/software/gnulib/manual.css"><link rel="stylesheet" type="text/css" href="/stylesheets/doc.css">@' ledger3.html -i
            '';
-
-         postInstall = ''
-           # Install print version of ledger manpage
-           cp ledger.1.pdf $out/share/doc/ledger
-           '';
        };
 
        doc-ledger-mode = pkgs.stdenvNoCC.mkDerivation rec {
@@ -128,6 +121,7 @@
            runHook preBuild
            texi2pdf --batch ledger-mode.texi
            makeinfo --force --html --no-split ledger-mode.texi
+           makeinfo --force --plaintext --no-split -o ledger-mode.txt ledger-mode.texi
            # Patch web version of ledger mode manual to support dark mode
            sed -e 's@</style>@&\n<link rel="stylesheet" type="text/css" href="https://www.gnu.org/software/gnulib/manual.css"><link rel="stylesheet" type="text/css" href="/stylesheets/doc.css">@' ledger-mode.html -i
            runHook postBuild
@@ -136,7 +130,7 @@
          installPhase = ''
            runHook preInstall
            mkdir -p $out
-           cp ledger-mode.html ledger-mode.pdf $out/
+           cp ledger-mode.html ledger-mode.pdf ledger-mode.txt $out/
            runHook postInstall
          '';
        };

flake.nix

@@ -4,10 +4,10 @@ title: Documentation - Ledger
 
 # Documentation
 
-* [**Ledger 3 manual**](doc/ledger3.html) and [pdf](doc/ledger3.pdf) ([changes](https://git.ledger-cli.org/ledger/commits/master/doc/ledger3.texi))
-* [Ledger 3 man page](doc/ledger.1.html) and [pdf](doc/ledger.1.pdf) ([changes](https://git.ledger-cli.org/ledger/commits/master/doc/ledger.1))
+* [**Ledger 3 manual**](doc/ledger3.html) as [pdf](doc/ledger3.pdf) or [txt](doc/ledger3.txt) ([changes](https://git.ledger-cli.org/ledger/commits/master/doc/ledger3.texi))
+* [Ledger 3 man page](doc/ledger.1.html) as [pdf](doc/ledger.1.pdf) ([changes](https://git.ledger-cli.org/ledger/commits/master/doc/ledger.1))
 * [Ledger 3 API documentation](doc/api)
-* [ledger-mode manual](doc/ledger-mode.html) and [pdf](doc/ledger-mode.pdf) ([changes](https://git.ledger-cli.org/ledger-mode/commits/master/doc/ledger-mode.texi))
+* [ledger-mode manual](doc/ledger-mode.html) as [pdf](doc/ledger-mode.pdf) or [txt](doc/ledger-mode.txt) ([changes](https://git.ledger-cli.org/ledger-mode/commits/master/doc/ledger-mode.texi))
 
 ## External links