CC-Tweaked

Commit Graph

Author	SHA1	Message	Date
Jonathan Coates	7f57a977a1	Make the CF link https on tweaked.cc It doesn't play nice on GH, but we need it on our actual website.	2020-04-22 14:48:42 +01:00
SquidDev	f9f94b8304	Rewrite our documentation index We're going to flesh this out a lot in the future, but this'll have to do for now.	2020-04-16 18:18:36 +01:00
Jonathan Coates	ef8da8054f	An initial stab at documentation generation (#360 ) 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/	2020-04-10 10:27:53 +01:00

Author

SHA1

Message

Date

Jonathan Coates

7f57a977a1

Make the CF link https on tweaked.cc

It doesn't play nice on GH, but we need it on our actual website.

2020-04-22 14:48:42 +01:00

SquidDev

f9f94b8304

Rewrite our documentation index

We're going to flesh this out a lot in the future, but this'll have to
do for now.

2020-04-16 18:18:36 +01:00

Jonathan Coates

ef8da8054f

An initial stab at documentation generation (#360 )

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/

2020-04-10 10:27:53 +01:00

3 Commits