qyriad/lix
1
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

doc/hacking: fix internal api docs section to say to enable it

Browse source 
I filed a bug to build these in releng in the future:
lix-project/lix#422

Change-Id: I476a2516cc2be382d4b7c8529a02f9212a78fdb2
This commit is contained in:
jade 2024-06-25 21:26:18 -07:00
parent e537678f1e
commit 33d53c4983
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/manual/src/contributing/hacking.md
View file

@ -282,9 +282,8 @@ Regular markdown files used for the manual have a base path of their own and the
## API documentation ## API documentation
Doxygen API documentation is [available Doxygen API documentation will be available online [in the future](https://git.lix.systems/lix-project/lix/issues/422).
online](https://hydra.nixos.org/job/nix/master/internal-api-docs/latest/download-by-type/doc/internal-api-docs). You You can also build and view it yourself:
can also build and view it yourself:
```console ```console
# nix build .#hydraJobs.internal-api-docs # 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: or inside a `nix develop` shell by running:
```bash ```bash
$ meson configure build -Dinternal-api-docs=enabled
$ meson compile -C build internal-api-docs $ meson compile -C build internal-api-docs
$ xdg-open ./outputs/doc/share/doc/nix/internal-api/html/index.html $ xdg-open ./outputs/doc/share/doc/nix/internal-api/html/index.html
``` ```