Commit Graph

22 Commits (7fd2ed391b17b143bf908b721e8696fd26006698)

Author SHA1 Message Date
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
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 61914f8dc7
docs: add docs for sink type (closes #233) 2023-02-07 15:39:22 -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
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