I wish I had aspirations for this being some standard that someone else might follow, but realistically I'm just irritated at my own laziness with regard to documentation, so I wrote a solution. The forceful nature of the validator is really just because I didn't want to write a smarter parser. As an added bonus, all the docs now look the same when I look at them in the repl, so that's kind of nice.
-If you like, you can [download it](https://github.com/frankduncan/sheep/releases/download/0.3/sheep_0.3.tar.gz)
+If you like, you can [download it](https://consxy.com/sheep/releases/0.3/docgen_0.3.tar.gz)
## Usage
-See the [wiki](https://github.com/frankduncan/sheep/wiki) for usage information (generated by this package).
+See [Reference](https://consxy.com/sheep/reference.html) for usage information (generated by this package).
To see how that page was created, take a look at bin/generatedocs.sh
EXAMPLES:
(let ((*variable* t)) (go)) => let-it-go
-````
+```
There are three required sections and one optional section. ```VALUE TYPE```, ```INITIAL VALUE```, and ```DESCRIPTION``` are freeform, with the ```EXAMPLES``` section following the same rules as below in the function documentation.
Functions should follow the template:
-````
+```
FUNC PATH => RESULT
RESULT: SUCCESS-RESULTS | FAILURE-RESULT
(func #P\"path/to/file.lisp\" t) => (:success \"path/to/file.lisp\")
(func #P\"path/to/error.lisp\" nil) => (:failure \"path/to/error.lisp\" \"Error msg\")
-````
+```
There are four sections to each function definition:
projects / sheep / blobdiff