diff options
| author | Jade Lovelace <lix@jade.fyi> | 2024-06-25 21:26:18 -0700 |
|---|---|---|
| committer | Jade Lovelace <lix@jade.fyi> | 2024-06-25 21:26:18 -0700 |
| commit | 33d53c49832ba27f7a29a553287b552599653268 (patch) | |
| tree | 8e994838886802d18c03eadccce397c6476409a1 | |
| parent | e537678f1ecfa3c1a145977e752ab826b10386ca (diff) | |
doc/hacking: fix internal api docs section to say to enable it
I filed a bug to build these in releng in the future:
https://git.lix.systems/lix-project/lix/issues/422
Change-Id: I476a2516cc2be382d4b7c8529a02f9212a78fdb2
| -rw-r--r-- | doc/manual/src/contributing/hacking.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/manual/src/contributing/hacking.md b/doc/manual/src/contributing/hacking.md index 3fe6022d4..730e5bbb2 100644 --- a/doc/manual/src/contributing/hacking.md +++ b/doc/manual/src/contributing/hacking.md @@ -282,9 +282,8 @@ Regular markdown files used for the manual have a base path of their own and the ## API documentation -Doxygen API documentation is [available -online](https://hydra.nixos.org/job/nix/master/internal-api-docs/latest/download-by-type/doc/internal-api-docs). You -can also build and view it yourself: +Doxygen API documentation will be available online [in the future](https://git.lix.systems/lix-project/lix/issues/422). +You can also build and view it yourself: ```console # nix build .#hydraJobs.internal-api-docs @@ -294,6 +293,7 @@ can also build and view it yourself: or inside a `nix develop` shell by running: ```bash +$ meson configure build -Dinternal-api-docs=enabled $ meson compile -C build internal-api-docs $ xdg-open ./outputs/doc/share/doc/nix/internal-api/html/index.html ``` |