Commit Graph

981 Commits (docs-refactor)

Author SHA1 Message Date
sammyette e1177b5a04
chore: remove lua docgen 2022-12-14 23:57:04 -04:00
sammyette 0f97abef0f
docs: support field docs for modules 2022-12-14 23:54:10 -04:00
sammyette a7767d9853
chore: merge 2022-12-14 22:44:29 -04:00
sammyette 9128a3ff2e
fix: log files for generated docs 2022-12-14 22:44:02 -04:00
TorchedSammy 3c06f406ab docs: [ci] generate new docs 2022-12-15 02:35:17 +00:00
sammyette 3f60d9128d
docs: add generated docs 2022-12-14 22:34:40 -04:00
sammyette 731f11b5ba
ci: checkout with submodules 2022-12-14 22:29:39 -04:00
sammyette 1631f799b8
ci: run lua docgen 2022-12-14 22:25:49 -04:00
TorchedSammy 559538c910 docs: [ci] generate new docs 2022-12-15 02:23:07 +00:00
sammyette 642af2cfed
ci: build in docs action without workflow dependency 2022-12-14 22:22:31 -04:00
sammyette f70efd9dd1
ci: build docs on docs-refactor branch 2022-12-14 22:16:24 -04:00
sammyette 2b88461170
docs: add generated docs from lua 2022-12-14 22:14:04 -04:00
sammyette 9a42d399f0
docs: add hilbish.editor interface docs 2022-12-14 21:28:09 -04:00
sammyette 0357141fbc
docs: fix yaml metadata, symlink to hugo 2022-12-14 21:05:11 -04:00
sammyette 98eddf9004
docs: add hilbish.timers interface docs 2022-12-14 18:44:02 -04:00
sammyette 90023ffa89
docs: add hilbish.jobs docs, distinguish between properties and fields 2022-12-13 20:12:16 -04:00
sammyette 66c1eb95cd
docs: add docs for hilbish.runner interface 2022-12-13 19:02:22 -04:00
sammyette 309b7605e3
chore: merge from master 2022-12-13 16:21:12 -04:00
sammyette f94b8ae59b
chore: update golua for popen (#172)
* chore: update golua to popen branch

* chore: fix go sum

* chore: update golua with popen branch
2022-12-13 15:37:01 -04:00
sammyette 7b3dc951c9
docs: add website (#176) 2022-12-13 15:14:48 -04:00
sammyette 0a49e1a4ef
feat: print command errors via hook
this allows users to remove the handlers and print
a custom message to their liking
2022-12-13 12:57:27 -04:00
TorchedSammy 6ca36847f1
docs: add bolded notes/changes for building and installing hilbish 2.0 2022-12-12 21:04:04 -04:00
TorchedSammy 5ca728ba06
docs: change task link and notice 2022-12-12 21:03:36 -04:00
sammyette 813354b662
build!: set datadir of hilbish and change default prefix to /usr/local (#221)
BREAKING (ish) CHANGE: Hilbish will by default install to `/usr/local`. To revert this, set `PREFIX="/usr/"`
2022-12-12 21:01:44 -04:00
TorchedSammy 8d40179a73
fix(readline): dont do anything if length of input rune slice is 0
this fixes an issue when readline splits multiline input.
sometimes, the multiple lines just end up being "stray?"
inputs of enter plus a newline. this can happen if a user attempts
to prefire the enter key while a command is running, for example
2022-12-10 17:27:42 -04:00
TorchedSammy 65ff0c77ab
docs: write docs for hilbish.completions 2022-12-10 12:48:15 -04:00
TorchedSammy f7e725b5b9
docs: make note on task 2022-12-09 21:49:58 -04:00
sammyette 4ee160fb66
fix: provide correct command when navigating history (#214)
fixes an issue of going up and down in history results in the incorrect order of commands being inserted (nothing happens to the order in the history itself, just when navigating via arrow keys)

* fix: provide correct command when navigating history

previously, the order while navigating history
with the arrow keys would be incorrect
meaning the command you expect if you go u
then go back down would not be there

* chore: update changelog
2022-12-09 21:45:52 -04:00
TorchedSammy 1024f93446
chore: update changelog 2022-12-06 12:54:56 -04:00
TorchedSammy 9c8d7692bc
chore: revert "build: apply hilbish datadir to allow changing install path"
This reverts commit 9131c72501.
temporary revert, will have to apply datadir eventually
2022-12-06 10:29:47 -04:00
TorchedSammy 9131c72501
build: apply hilbish datadir to allow changing install path 2022-12-05 23:38:52 -04:00
TorchedSammy 26ff6c9a46
fix(nature/completions): get command name properly for custom completions 2022-12-05 23:15:35 -04:00
TorchedSammy 2ee506f958
docs: document history interface 2022-12-05 19:20:36 -04:00
TorchedSammy 9d5f6de064
docs: fully document aliases interface 2022-12-05 19:11:52 -04:00
TorchedSammy 525635787a
docs: add docs for os interface 2022-12-05 19:05:38 -04:00
TorchedSammy c45c6a61bc
docs: upload interface docs, fix gitignore for it 2022-12-05 19:05:28 -04:00
TorchedSammy 9e2d77d138
docs: add ability to document properties (and document hilbish.userDir) 2022-12-05 18:57:59 -04:00
TorchedSammy bb8045dd38
chore: merge from master 2022-12-05 18:08:00 -04:00
TorchedSammy 604dedb36d
chore: update lunacolors 2022-12-05 14:16:43 -04:00
TorchedSammy 0b1024de19
feat: add interface docs 2022-12-03 22:50:15 -04:00
TorchedSammy 23d18ef11c
docs: push fixed docs 2022-12-03 16:54:34 -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 4b5fcf24c2
docs: add descriptions for terminal and fs libs 2022-12-02 17:06:53 -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