doc: add default for generate_help_pages #425
Conversation
Review ChecklistDoes this PR follow the Contribution Guidelines? Following is a partial checklist: Proper conventional commit scoping:
If applicable:
|
teto
force-pushed
the
harmonize-doc-defautls
branch
from
7389c2c to
6b68290
Compare
|
ha I see it's generated ^^' |
The makefile target is kinda tautologic but it helps with discovery
teto
force-pushed
the
harmonize-doc-defautls
branch
from
e8e76a1 to
0265f16
Compare
.github/workflows/docgen.yaml
Outdated
| @@ -19,7 +19,7 @@ jobs: | |||
| authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}' | |||
|
|
|||
| - name: Generating docs | |||
| run: nix run ".#docgen" | |||
| run: nix develop --command "make docgen" | |||
There was a problem hiding this comment.
I totally get it if you dont like the change @mrcjkb (see commit message). The idea is that as developer I tend to look at how the CI is configured to run the same commands so I thought I would mimic what I would do. If it's too bothersome I can drop it. https://github.com/DeterminateSystems/magic-nix-cache-action is supposed to alleviate the extra nix installs but I dont have experience with it.
| @@ -127,6 +127,7 @@ | |||
| # to be generated | |||
| gcc | |||
| tree-sitter | |||
| docgen | |||
There was a problem hiding this comment.
I prefer to run docgen from within the shell then nix run .#docgen which is slower (it copies the fodler to the store + nix eval time).
This might be less optimal then the actual command as it installs more stuff but it might be closer to what a user will run.
tried to harmoinze the display of defaults as well
teto
force-pushed
the
harmonize-doc-defautls
branch
from
0265f16 to
0e1cd0f
Compare
skip-checks: true
tried to harmoinze the display of defaults as well