Add API documentation

Author: afh

.github/workflows/build_and_deploy.yml

@@ -32,6 +32,8 @@ jobs:
           cp result/share/doc/ledger/ledger* build/doc
           nix build .#doc-ledger-mode
           cp result/ledger-mode.* build/doc
+          nix build .#doc-ledger-api
+          cp -R result/share/doc/ledger/html build/doc/api/
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1
         with:

flake.lock

@@ -4,7 +4,7 @@
   nixConfig.bash-prompt = "ledger-cli.org$ ";
 
   inputs = {
-    nixpkgs.url = "nixpkgs/nixpkgs-unstable";
+    nixpkgs.url = "nixpkgs/nixpkgs-unstable"; # provides doxygen 1.9.6
     flake-utils.url = "github:numtide/flake-utils";
     # NOTA BENE: When a new release of ledger or ledger-mode is available, update
     # the tag in the url below and run `nix flake update`, so that GitHub Actions
@@ -13,9 +13,11 @@
     ledger.url = "github:ledger/ledger/master";
     ledger-mode.url = "github:ledger/ledger-mode/v4.0.0";
     ledger-mode.flake = false;
+    doxygen-awesome.url = "github:jothepro/doxygen-awesome-css/v2.2.0";
+    doxygen-awesome.flake = false;
   };
 
-  outputs = { self, nixpkgs, flake-utils, ledger, ledger-mode }:
+  outputs = { self, nixpkgs, flake-utils, ledger, ledger-mode, doxygen-awesome }:
     flake-utils.lib.eachDefaultSystem( system:
     let
       pkgs = import nixpkgs { inherit system; };
@@ -52,6 +54,32 @@
           '';
         };
 
+       doc-ledger-api = pkgs.stdenvNoCC.mkDerivation rec {
+         name = "ledger-api";
+
+         src = ledger;
+
+         nativeBuildInputs = with pkgs; [
+           cmake doxygen graphviz # doxygen uses dot from graphviz to create diagrams
+         ];
+
+         enableParallelBuilding = false;
+
+         preConfigure = "cd doc";
+
+         cmakeFlags = [
+          "-Wno-dev"
+          "-DUSE_DOXYGEN:BOOL=ON"
+          "-DDOXYGEN_EXTRA_CSS:STRING=${doxygen-awesome}/doxygen-awesome.css"
+         ];
+
+         # Ensure the "generated on date at time" footer shows the actual date and time
+         # when the API documentation was generated.
+         preBuild = "export SOURCE_DATE_EPOCH=$(date +'%s')";
+
+         buildFlags = "doc.doxygen";
+       };
+
        doc-ledger = pkgs.stdenvNoCC.mkDerivation rec {
          name = "ledger";
 

flake.nix

@@ -6,6 +6,7 @@ title: Documentation - Ledger
 
 * [**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 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))
 
 ## External links