sammyette
3219c47071
docs: reorganize text and add more info
2023-12-25 22:32:37 -04:00
sammyette
0de305a9a3
docs: fix extra whitespace
2023-12-25 19:52:16 -04:00
sammyette
884bc1fd36
docs: add opts
2023-12-25 19:03:52 -04:00
sammyette
b0e05d4b16
feat: add nature module docs
2023-12-25 18:50:27 -04:00
sammyette
f312cc2cac
docs: improve docs for signals
2023-12-24 18:23:10 -04:00
sammyette
433ffa5068
docs: move Hooks to Signals
2023-12-18 13:33:12 -04:00
sammyette
2cac53d6e7
feat(commands/doc): display separator, add space in code block
2023-12-18 10:16:57 -04:00
sammyette
7f6c459ba2
docs: fix extra backtick in codeblock
2023-12-17 22:20:41 -04:00
sammyette
90ef8f7a9c
refactor: update documentation for everything
2023-12-03 20:54:00 -04:00
sammyette
7cd1170e41
chore: reorder hilbish.completion functions
2023-12-02 13:06:42 -04:00
sammyette
93c0645d12
docs: update hilbish.completion
2023-12-02 13:03:19 -04:00
sammyette
1f7f8e5104
docs: update api docs, make others show up on site
2023-12-02 10:49:50 -04:00
sammyette
f40ce3c8f7
chore: update docs
2023-12-02 08:23:49 -04:00
sammyette
bb8d072b8c
website(docs/commander): rewrite commander docs
2023-11-30 22:19:13 -04:00
sammyette
068ef7a376
website(docs/bait): add example for throw function
2023-11-30 22:09:07 -04:00
sammyette
d921d3f752
website(docs/bait): complete documentation
2023-11-30 22:07:48 -04:00
sammyette
2363e6ff2f
website(docs): add example
2023-11-30 18:30:54 -04:00
sammyette
5be470521f
refactor: move misc docs for use in hilbish and website
2023-11-11 22:28:18 -04:00
sammyette
0f923a6f80
chore: merge from master
2023-11-11 21:57:15 -04:00
sammyette
29e14c1aee
feat: native modules ( #257 )
2023-11-11 19:39:31 -05:00
sammyette
78eb657897
feat: hilbish native pager ( #240 )
2023-10-25 00:41:53 -04:00
sammyette
726082ba03
docs: fix duplicate functions header
2023-09-09 13:38:54 -04:00
sammyette
7fd2ed391b
docs: add separators for types, make object properties into tables
2023-09-02 16:11:57 -04:00
sammyette
0900284304
docs: turn properties list into a table
...
also fix member functions causing a spam of separators
2023-09-02 16:01:57 -04:00
sammyette
eda4fda972
docs(commander): remove note about input sink being unimplemented
2023-09-02 15:32:53 -04:00
sammyette
aa7e899db4
docs: make various style changes
...
- add a table that lists module functions
- add highlight when jumping to a function
- separators
2023-09-02 14:18:40 -04:00
sammyette
81b7e20cbf
docs: add better introduction for bait module
...
also highlights codeblocks better
2023-09-02 12:57:13 -04:00
sammyette
7c1984135b
docs: add detailed parameter listing, change interface to modules
...
there are a few changes here
- documentation of each parameter separately has been added
to the generated text docs
- interfaces have been renamed to modules. this was honestly a pointless
and confusing distinction (interfaces are tables for modules that are
lua modules). it also makes it so that (formerly) interfaces and
modules line up with each other on the doc list
im not sure what else i did, these are old changes
2023-08-26 11:30:51 -04:00
TorchedSammy
ab26b82a9f
docs: [ci] generate new docs
2023-07-11 01:57:00 +00:00
sammyette
c6c81ddece
feat: add notification/message interface ( #239 )
...
details in #219
2023-07-10 19:03:30 -04:00
TorchedSammy
6729ecddea
docs: [ci] generate new docs
2023-04-15 14:36:56 +00:00
TorchedSammy
0379e302ac
docs: [ci] generate new docs
2023-03-25 21:42:46 +00:00
TorchedSammy
c55cd345ba
docs: [ci] generate new docs
2023-02-07 22:19:24 +00:00
sammyette
2911257eb9
docs: cleanup completions doc to better fit 80 col terminals
2023-02-07 17:42:16 -04:00
sammyette
61914f8dc7
docs: add docs for sink type ( closes #233 )
2023-02-07 15:39:22 -04:00
sammyette
890f10e176
docs: update runner-mode doc ( closes #230 )
2023-02-07 10:46:29 -04:00
sammyette
2f6ab5fd92
feat: add sink for commanders to write output/read input ( #232 )
...
to write output, you would usually just use the print builtin
since commanders are just lua custom commands but this does not
consider the fact of pipes or other shell operators being used
to redirect or whatever.
this adds readable/writable "sinks" which is a type for input
or output and is currently only used for commanders but can be
used for other hilbish things in the future
2023-01-20 19:07:42 -04:00
TorchedSammy
c87fbe2b99
docs: [ci] generate new docs
2023-01-18 10:59:10 +00:00
sammyette
6530d48b00
docs: document types properly ( #227 )
2023-01-18 06:39:26 -04:00
TorchedSammy
a2f0ff3e09
docs: [ci] generate new docs
2023-01-07 15:52:49 +00:00
sammyette
91ec0cf4a4
docs: remove api index (there is already _index)
2022-12-28 22:26:20 -04:00
TorchedSammy
68a37d8c79
docs: [ci] generate new docs
2022-12-28 23:33:44 +00:00
sammyette
61f6337f5f
docs: improve docs for timers interface
2022-12-28 19:32:52 -04:00
sammyette
0f33f72de7
docs: fix docs for outdated hook
2022-12-28 19:28:16 -04:00
TorchedSammy
7234111d6d
docs: [ci] generate new docs
2022-12-21 01:00:31 +00:00
sammyette
a105b8e38d
docs: improve emmy lua annotations
2022-12-20 20:59:55 -04:00
sammyette
5ea23d58d1
docs: change api index doc
2022-12-20 10:09:08 -04:00
sammyette
b46bd0059e
fix: fixes for doc command
...
- get docs properly for hilbish module and its interfaces
- deal with negative numbers causing yaml metadata parsing to fail
- change from index to _index to match hugo
2022-12-20 01:38:19 -04:00
sammyette
e5eefb1d2d
refactor!: rework docs and doc command ( #218 )
...
changes the actual file format of docs to markup since that's basically what we have been
using in the first place.
the docgen command has been modified to write markdown headings with the function name and
yaml metadata for easy consumption by hugo for the website.
all other docs have been moved to markdown as well this is the main reason this is a "breaking" change
users will have to reinstall hilbish (task uninstall and task install) to remove the old plaintext docs
2022-12-15 00:00:54 -04:00
TorchedSammy
ff4609e432
feat: add hilbish.cancel hook ( closes #213 )
2022-11-25 19:21:36 -04:00