docs: add default for generate_help_pages (#425)

* chore(flake): expose docgen in devShell

The makefile target is kinda tautologic but it helps with discovery

* ci: update workflow

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.

* doc: add default for 'generate_help_pages'

tried to harmoinze the display of defaults as well

* docs(generated): update doc/rocks.txt
skip-checks: true

---------

Co-authored-by: Github Actions <actions@github>

.github/workflows/docgen.yaml

@@ -19,7 +19,7 @@ jobs:
           authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
 
       - name: Generating docs
-        run: nix run ".#docgen"
+        run: nix develop --command make docgen
 
       - name: Update documentation
         env:

Makefile

@@ -3,3 +3,6 @@ format:
 
 check:
 	luacheck lua/rocks plugin/ installer.lua
+
+docgen:
+	docgen

doc/rocks.txt

@@ -65,9 +65,9 @@ RocksOpts                                                            *RocksOpts*
         {luarocks_binary?}                (string)   Luarocks binary path. Defaults to `{rocks_path}/bin/luarocks`.
         {lazy?}                           (boolean)  Whether to query luarocks.org lazily. Defaults to `false`. Setting this to `true` may improve startup time, but features like auto-completion will lag initially.
         {dynamic_rtp?}                    (boolean)  Whether to automatically add freshly installed plugins to the 'runtimepath'. Defaults to `true` for the best default experience.
-        {generate_help_pages?}            (boolean)  Whether to re-generate plugins help pages after installation/upgrade.
+        {generate_help_pages?}            (boolean)  Whether to re-generate plugins help pages after installation/upgrade. Defaults to `true`.
         {reinstall_dev_rocks_on_update?}  (boolean)  Whether to reinstall 'dev' rocks on update (Default: `true`, as rocks.nvim cannot determine if 'dev' rocks are up to date).
-        {enable_luarocks_loader?}         (boolean)  Whether to use the luarocks loader to support multiple dependencies (Default: `true`)
+        {enable_luarocks_loader?}         (boolean)  Whether to use the luarocks loader to support multiple dependencies (Default: `true`).
         {luarocks_config?}                (string)   Path to the luarocks config. If not set, rocks.nvim will create one in `rocks_path`. Warning: You should include the settings in the default luarocks-config.lua before overriding this.
 
 

flake.nix

@@ -127,6 +127,7 @@
               # to be generated
               gcc
               tree-sitter
+              docgen
             ])
             ++ oa.buildInputs
             ++ oa.propagatedBuildInputs;

lua/rocks/config/init.lua

@@ -19,9 +19,9 @@ local config = {}
 ---@field luarocks_binary? string Luarocks binary path. Defaults to `{rocks_path}/bin/luarocks`.
 ---@field lazy? boolean Whether to query luarocks.org lazily. Defaults to `false`. Setting this to `true` may improve startup time, but features like auto-completion will lag initially.
 ---@field dynamic_rtp? boolean Whether to automatically add freshly installed plugins to the 'runtimepath'. Defaults to `true` for the best default experience.
----@field generate_help_pages? boolean Whether to re-generate plugins help pages after installation/upgrade.
+---@field generate_help_pages? boolean Whether to re-generate plugins help pages after installation/upgrade. Defaults to `true`.
 ---@field reinstall_dev_rocks_on_update? boolean Whether to reinstall 'dev' rocks on update (Default: `true`, as rocks.nvim cannot determine if 'dev' rocks are up to date).
----@field enable_luarocks_loader? boolean Whether to use the luarocks loader to support multiple dependencies (Default: `true`)
+---@field enable_luarocks_loader? boolean Whether to use the luarocks loader to support multiple dependencies (Default: `true`).
 ---@field luarocks_config? string Path to the luarocks config. If not set, rocks.nvim will create one in `rocks_path`. Warning: You should include the settings in the default luarocks-config.lua before overriding this.
 
 ---@type RocksOpts | fun():RocksOpts