Skip to content

Commit

Permalink
docs: generate the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
abougouffa committed Nov 20, 2024
1 parent dc2eca5 commit 9bf607c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 33 deletions.
46 changes: 14 additions & 32 deletions docs/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -371,18 +371,6 @@ value of this method instead of the original alist, to ensure correct results.
Duplicate elements in MODE-ALIST to include Treesit modes.
For the alist =((some-mode . spec)), this will add =(some-ts-mode . spec).

#### `(+set-standard-value VARIABLE VALUE)`

Set the standard value of VARIABLE to VALUE.

#### `(+standard-value VARIABLE)`

Return the standard value for VARIABLE.

#### `(+reset-standard-value VARIABLE)`

Reset VARIABLE to its standard value.

#### `(+unquote EXPR)`

Return EXPR unquoted.
Expand All @@ -396,6 +384,12 @@ Return t when EXPR is quoted.

Like `apply-partially`, but apply the ARGS to the right of FUN.

#### `(+apply-inhibit-messages FN &rest ARGS)`

Call FN with ARGS while to suppressing the messages in echo area.
If `minemacs-verbose-p` is non-nil, do not print any message to
*Messages* buffer.

#### `(+error! MSG &rest VARS)` (macro)

Log error MSG and VARS using `message`.
Expand All @@ -412,20 +406,11 @@ Log MSG and VARS using `message` when `minemacs-verbose-p` is non-nil.

Log debug MSG and VARS using `message` when `minemacs-msg-level` is 4.

#### `(+fn-inhibit-messages! FN &optional NO-MESSAGE-LOG)` (macro)

Add an advice around the function FN to suppress messages in echo area.
If NO-MESSAGE-LOG is non-nil, do not print any message to *Messages* buffer.

#### `(+shutup! &rest BODY)` (macro)

Suppress new messages temporarily while evaluating BODY.
This inhebits both the echo area and the `*Messages*` buffer.

#### `(+cmdfy! &rest BODY)` (macro)

Convert BODY to an interactive command.

#### `(+load-theme)`

Load Emacs' theme from `minemacs-theme`.
Expand Down Expand Up @@ -503,6 +488,11 @@ Optionally, check also for the containing MODULE.
List all the available modules.
With optional INCLUDE-ON-DEMAND and INCLUDE-OBSOLETE.

#### `(+describe-random-command)`

Show the documentation for a random command.
Consider only documented, non-obsolete interactive functions.

#### `(+shell-command-to-string-ignore-stderr COMMAND)`

Execute shell command COMMAND and return its output as a string.
Expand Down Expand Up @@ -539,9 +529,9 @@ that directory.

Return non-nil if the resource NAME is locked.

#### `(+locked-by-this-process-p NAME)`
#### `(+locked-by-current-process-p NAME)`

Return non-nil if the resource NAME locked by this Emacs instance.
Return non-nil if the resource NAME locked by the current Emacs instance.

#### `(+lock NAME)`

Expand All @@ -564,7 +554,7 @@ be deleted.

Auto-enable Eglot in configured modes in `+eglot-auto-enable-modes`.

#### `(+eglot-use-on-all-supported-modes MODE-LIST)`
#### `(+eglot-use-on-all-supported-modes &optional MODE-LIST)`

Add all modes in MODE-LIST to `+eglot-auto-enable-modes`.

Expand Down Expand Up @@ -608,14 +598,6 @@ Set *_proxy Linux environment variables from PROXIES.

Unset *_proxy Linux environment variables.

#### `(+with-proxies &rest BODY)` (macro)

Execute BODY with proxies enabled from `minemacs-proxies`.

#### `(+with-no-proxies &rest BODY)` (macro)

Execute BODY with proxies disabled.

#### `(+serialize-sym SYM &optional DIR FILENAME-FORMAT)`

Serialize SYM to DIR.
Expand Down
2 changes: 1 addition & 1 deletion docs/PACKAGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@
* `magit`: It's Magit! A Git Porcelain inside Emacs.
* `git-commit`: Edit Git commit messages - part of `magit`
* `magit-todos`: Show source files' TODOs (and FIXMEs, etc) in Magit status buffer
* `magit-iconify`: File icons for Magit based on `nerd-icons`
* `magit-file-icons`: File icons for Magit based on `nerd-icons`
* `magit-imerge`: Magit extension for "git-imerge"
* `multi-magit`: A set of extensions for `magit` to handle multiple repositories simultaneously
* `closql`: Store EIEIO objects using EmacSQL
Expand Down

0 comments on commit 9bf607c

Please sign in to comment.