mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-06-29 00:23:23 +00:00
ef8da8054f
This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/
53 lines
1.7 KiB
Common Lisp
53 lines
1.7 KiB
Common Lisp
; -*- mode: Lisp;-*-
|
|
|
|
(sources
|
|
/doc/stub/
|
|
/src/main/resources/assets/computercraft/lua/bios.lua
|
|
/src/main/resources/assets/computercraft/lua/rom/
|
|
/src/test/resources/test-rom)
|
|
|
|
|
|
(doc
|
|
(title "CC: Tweaked")
|
|
(index doc/index.md)
|
|
(source-link https://github.com/SquidDev-CC/CC-Tweaked/blob/${commit}/${path}#L${line})
|
|
|
|
(library-path
|
|
/doc/stub/
|
|
|
|
/src/main/resources/assets/computercraft/lua/rom/apis
|
|
/src/main/resources/assets/computercraft/lua/rom/apis/command
|
|
/src/main/resources/assets/computercraft/lua/rom/apis/turtle
|
|
|
|
/src/main/resources/assets/computercraft/lua/rom/modules/main
|
|
/src/main/resources/assets/computercraft/lua/rom/modules/command
|
|
/src/main/resources/assets/computercraft/lua/rom/modules/turtle))
|
|
|
|
(at /
|
|
(linters
|
|
;; It'd be nice to avoid this, but right now there's a lot of instances of
|
|
;; it.
|
|
-var:set-loop
|
|
|
|
;; It's useful to name arguments for documentation, so we allow this. It'd
|
|
;; be good to find a compromise in the future, but this works for now.
|
|
-var:unused-arg
|
|
|
|
;; Suppress a couple of documentation comments warnings for now. We'll
|
|
;; hopefully be able to remove them in the future.
|
|
-doc:undocumented -doc:undocumented-arg -doc:unresolved-reference
|
|
-var:unresolved-member))
|
|
|
|
;; We disable the unused global linter in bios.lua and the APIs. In the future
|
|
;; hopefully we'll get illuaminate to handle this.
|
|
(at
|
|
(/src/main/resources/assets/computercraft/lua/bios.lua
|
|
/src/main/resources/assets/computercraft/lua/rom/apis/)
|
|
(linters -var:unused-global)
|
|
(lint (allow-toplevel-global true)))
|
|
|
|
;; Silence some variable warnings in documentation stubs.
|
|
(at /doc/stub
|
|
(linters -var:unused-global)
|
|
(lint (allow-toplevel-global true)))
|