sammyette
0f97abef0f
docs: support field docs for modules
2022-12-14 23:54:10 -04:00
sammyette
9128a3ff2e
fix: log files for generated docs
2022-12-14 22:44:02 -04:00
sammyette
2b88461170
docs: add generated docs from lua
2022-12-14 22:14:04 -04:00
sammyette
0357141fbc
docs: fix yaml metadata, symlink to hugo
2022-12-14 21:05:11 -04:00
sammyette
90023ffa89
docs: add hilbish.jobs docs, distinguish between properties and fields
2022-12-13 20:12:16 -04:00
TorchedSammy
9e2d77d138
docs: add ability to document properties (and document hilbish.userDir)
2022-12-05 18:57:59 -04:00
TorchedSammy
0b1024de19
feat: add interface docs
2022-12-03 22:50:15 -04:00
TorchedSammy
c05b1b6168
fix: pass other needed params to goroutine to prevent mixups
2022-12-03 16:52:52 -04:00
TorchedSammy
4f959c326a
feat: use goroutines for doc gen loop
2022-12-03 11:33:18 -04:00
TorchedSammy
079bedc6dc
fix: use slice for doc pieces instead of a map
...
a map doesnt have a fixed order which results in
a new order everytime docs are generated. i forgot
that important detail..
2022-12-03 11:30:41 -04:00
TorchedSammy
aa43515213
refactor: reduce duplication and reorganize code in doc gen
2022-12-03 11:15:25 -04:00
TorchedSammy
9df0c4c0df
fix: remove empty entries for hilbish module, add descriptions
2022-12-02 17:02:13 -04:00
TorchedSammy
e258f9c8ba
fix: doc generation for hilbish module
2022-12-02 16:57:38 -04:00
TorchedSammy
65e35dbab9
style: make structs unexported
2022-12-02 16:00:55 -04:00
TorchedSammy
1b24e91597
feat!: enhance docs and doc command
...
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 (soon).
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-02 15:08:03 -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 3f1f698511
.
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