Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Lua API docs #4

Merged
merged 13 commits into from
Sep 22, 2020
Merged

Add Lua API docs #4

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
963dc54
Start Lua API reference addition
twaritwaikar Sep 19, 2020
1c58f48
Add Lua API docs from JSON
twaritwaikar Sep 19, 2020
6ea5e77
Add type formatting to Lua API ref
twaritwaikar Sep 19, 2020
be94fc3
Remove python only function docs
twaritwaikar Sep 20, 2020
adae336
Add contents table + linkabled class members
twaritwaikar Sep 21, 2020
1468593
Change BOOL to boolean in lua api ref
twaritwaikar Sep 21, 2020
ee697dc
Add multiple types in lua property table
twaritwaikar Sep 21, 2020
68a4b9a
Make Lua api members as links + reorderings
twaritwaikar Sep 21, 2020
76664eb
Manual review Lua API over Lua API functions and properties
twaritwaikar Sep 22, 2020
d86887b
Remove python only tables from Lua api content table
twaritwaikar Sep 22, 2020
edd8822
Fix new() returns mentioned as nil in lua api
twaritwaikar Sep 22, 2020
0ca8727
Remove Python mannerisms from Lua docs
twaritwaikar Sep 22, 2020
1358469
Add script and data used to generate Lua API documentation
twaritwaikar Sep 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions assets/themes/librocket/css/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,3 +210,11 @@ a[href^="http"]:after {
max-height: 80vh;
padding-bottom: 1em;
}

.lua-type {
font-weight: bold;
}

.lua-method {
font-weight: bold;
}
8 changes: 8 additions & 0 deletions pages/lua_manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ status: improve
The documentation for using Lua with RmlUi is a work-in-progress. If you'd like to get started, please have a look at the `luainvaders` sample included with the library.

The Lua implementation works analogous to the old [Python scripting implementation](https://barotto.github.io/libRocketDoc/pages/python_manual.html) in libRocket. It may be helpful to check out its documentation.

## Integrating Lua

## Interfaces

## Appendix

1. [API reference](lua_manual/api_reference.html)
Loading