mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2025-08-30 09:07:55 +00:00
Code Issues Releases Wiki Activity

An initial stab at documentation generation (#360)

Browse Source 
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/
This commit is contained in:
Jonathan Coates
2020-04-10 10:27:53 +01:00
committed by GitHub
parent 1ccd687c00
commit ef8da8054f
39 changed files with 2094 additions and 336 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/index.md Normal file
View File

@@ -0,0 +1,13 @@
# CC: Tweaked
This is a small website to test documentation generation from Lua source code.
This is still very much in the proof-of-concept stage. We've rolled own own documentation
generation tool, and there's a couple of missing features. Furthermore, Java-based APIs
(such as Lua builtins, or @{os}) are not documented.
For more information, please check out [the GitHub issue][gh_issue] and [the
documented source][gh_branch].
[gh_issue]: https://github.com/SquidDev-CC/CC-Tweaked/issues/133
[gh_branch]: https://github.com/SquidDev-CC/CC-Tweaked/tree/feature/doc-gen