Script to create Lua API documentation in html.

Forum for OctaneRender Lua scripting examples, discussion and support.
User avatar
stratified
OctaneRender Team
Posts: 945
Joined: Wed Aug 15, 2012 6:32 am
Location: Auckland, New Zealand

ultrafish wrote:This script is crashing with the current demo version of octane because octane[moduleName] == nil when moduleName == 'benchmark' or 'octane'. The crash happens on lines 122 and 164. I was able to put checks in for myself, but I didn't want to post my code since I'm very new to octane and I thought it might be an issue only with the demo version.

Thanks.
Hi,

I'll update this script as soon as I have some time.

cheers,
Thomas
User avatar
stratified
OctaneRender Team
Posts: 945
Joined: Wed Aug 15, 2012 6:32 am
Location: Auckland, New Zealand

I've attached an updated script to the first post. Should work now.

cheers,
Thomas
Wallan
Licensed Customer
Posts: 47
Joined: Fri Jan 23, 2015 6:13 pm

Get an error when trying to run the scriupt.

[string "create-docs.lua"]:136: bad argument #1 to 'functionDoc' (string expected, got function)
Windows 7 Ultimate 64bit 32Gb RAM. Intel Core i7-5820K [email protected] GHZ. Display uses a Gigabyte GTX 460 1Gb VRAM. Octane uses an EVGA GTX 970 4Gb VRAM.
User avatar
stratified
OctaneRender Team
Posts: 945
Joined: Wed Aug 15, 2012 6:32 am
Location: Auckland, New Zealand

Hi,

There are 2 versions of the script attached to the first post (create-docs.lua and create-docs_213.lua). I think you're trying to run create-docs.lua on an OctaneRender version higher than 2.13.

cheers,
Thomas
Wallan
Licensed Customer
Posts: 47
Joined: Fri Jan 23, 2015 6:13 pm

You are so very correct on that one :oops:

Thanks
Windows 7 Ultimate 64bit 32Gb RAM. Intel Core i7-5820K [email protected] GHZ. Display uses a Gigabyte GTX 460 1Gb VRAM. Octane uses an EVGA GTX 970 4Gb VRAM.
Jenish535
Posts: 1
Joined: Thu Dec 05, 2024 3:27 am

It's 2026 already...

Can someone add latest doc in html as the current version is old and so many functions are changed
User avatar
bepeg4d
Octane Guru
Posts: 10536
Joined: Wed Jun 02, 2010 6:02 am
Location: Italy
Contact:

Jenish535 wrote: Thu Mar 05, 2026 11:17 am It's 2026 already...

Can someone add latest doc in html as the current version is old and so many functions are changed
Hi,

OctaneRender documentation is updated and in .htm from some time:
https://docs.otoy.com/standaloneSE/CoverPage.html

And about LUA API, if you run the script in the first page of this discussion in OctaneRender Standalone 2026.2 you get this:
IMG_7177.jpeg
OctaneRender_doc_2026_2.zip
(129.11 KiB) Downloaded 3 times
Happy GPU rendering!

ciao,
Beppe
Post Reply

Return to “Lua Scripting”