2
2
mirror of https://github.com/Hilbis/Hilbish synced 2025-04-04 20:53:24 +00:00

21 Commits

Author SHA1 Message Date
c121356e0f
docs: fix snail docs 2025-04-02 21:42:45 -04:00
a2e23f1310
docs: attempt 2025-04-02 21:30:16 -04:00
4150001d8b
fix: make lua implemented hilbish interfaces documented (#335)
* fix: make lua implemented hilbish interfaces documented

* fix: signature link in table of contents

* fix: reduce function list to match in go generated docs

* fix: toc appending

* docs: enable docs for hilbish.messages

* feat: add description gen, and more spacing between param listing

* docs: add more detailed documentation for lua modules

* docs: update hilbish.messages docs

* fix: add description for lua doc'd modules, remove duplicate docs

* docs: add back hilbish.jobs doc

* feat: generate toc for lua modules

* fix: add table heading

* ci: add lua docgen

* docs: put dirs.old doc on 1 line
2025-04-02 09:41:37 -04:00
a20123fc24
feat: allow hilbish.run to take a table of files to use for output (#291) 2024-04-27 21:03:54 -04:00
8fdae6c1d7
refactor: doc improvements (again) (#260) 2023-12-25 22:08:29 -05:00
29e14c1aee
feat: native modules (#257) 2023-11-11 19:39:31 -05:00
61914f8dc7
docs: add docs for sink type (closes #233) 2023-02-07 15:39:22 -04:00
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
6530d48b00
docs: document types properly (#227) 2023-01-18 06:39:26 -04:00
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
b712efd278
fix(docgen): make functions that take varargs have the signature 2022-04-04 21:34:46 -04:00
TorchedSammy
e75c60ff49
feat(docgen): support outputting emmylua sources (closes #91) 2022-02-25 18:00:18 -04:00
TorchedSammy
d1b7515722
fix(docgen): remove trailing spaces in docs 2022-02-24 20:42:54 -04:00
TorchedSammy
b468727a32
refactor(docgen): remove global doc 2022-02-24 20:37:13 -04:00
TorchedSammy
82b4fa5e7c
fix(docgen): revert "fix(docgen): trim trailing space from doc comments"
This reverts commit 3f1f6985119d73a00e9150d244fc108914e49de5.
removes the newlines, dont do this for now
2021-12-07 17:08:25 -04:00
TorchedSammy
3f1f698511
fix(docgen): trim trailing space from doc comments 2021-12-07 16:57:53 -04:00
sammyette
3d53e85fc9
feat: add terminal package
a simple, smaller but lower level terminal library, mainly used to set
raw mode. functions:
size, save and restore current state, set raw mode. documentation is in
docs/terminal.txt or `doc terminal` in hilbish
2021-10-17 16:10:57 -04:00
sammyette
54635072f6
fix(docgen): use better perm mask for output files and folder 2021-10-16 15:38:17 -04:00
sammyette
a2f54b627b
feat: output docs to a docs folder, allow multiline docs 2021-10-16 12:38:46 -04:00
sammyette
1689d80721
feat: add docgen program, document almost all hilbish functions 2021-10-16 10:21:05 -04:00
sammyette
ecbcf9a968
feat: add docgen program 2021-10-15 23:58:56 -04:00