Skip to content

Commit

Permalink
Improved doc lib documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
HU90m authored and hcallahan-lowrisc committed Jan 24, 2024
1 parent 785de3d commit 8be8c43
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## The Documentation Library

The `doc` library contains `buildMdbookSite`, which is a helper function for creating mdBook site builds.
An example of it's use is below.
An example of its use is below.

```nix
let
Expand All @@ -25,6 +25,7 @@ in {
}
```

*Note: `pkgs.mdbook` is not required in nativeBuildInputs.*
Notice, that `pkgs.mdbook` doesn't need to be given as part of the `nativeBuildInputs`, so one only needs to provide dependencies of preprocessors run by mdBook.
In this case, just python.

`standardMdbookFileset` and `hasExts` are also provided to further help in creating derivations.

0 comments on commit 8be8c43

Please sign in to comment.