Skip to content

Commit

Permalink
Add guide for generating LuaLS docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rhys-vdw committed Dec 3, 2024
1 parent acaae02 commit 7cd39b9
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 3 deletions.
33 changes: 33 additions & 0 deletions doc/site/.luarc.doc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"$schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json",
"runtime.version": "Lua 5.1",
"completion.requireSeparator": "/",
"runtime.builtin": {
"basic": "disable",
"bit": "disable",
"bit32": "disable",
"builtin": "disable",
"coroutine": "disable",
"debug": "disable",
"ffi": "disable",
"io": "disable",
"jit": "disable",
"math": "disable",
"os": "disable",
"package": "disable",
"string": "disable",
"table": "disable",
"table.clear": "disable",
"table.new": "disable",
"utf8": "disable"
},
"runtime.path": [
"?",
"?.lua"
],
"runtime.special": {
"VFS.Include": "require",
"include": "require",
"shard_include": "require"
}
}
6 changes: 3 additions & 3 deletions doc/site/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ Navigate to http://localhost:4000/spring

## Generating LDoc

Have [LDoc](https://github.com/lunarmodules/LDoc) installed or available at your `$PATH`.
Have [Lua Language Server](https://luals.github.io/) installed or available at your `$PATH`.

Inside `doc/LDoc` run:
Inside `doc/site` run:

```bash
ldoc -c config.ld .
lua-language-server --configpath .luarc.doc.json --doc ../.. --doc_out_path _data
```

Keep in mind to see changes on the site you might have to restart jekyll.

0 comments on commit 7cd39b9

Please sign in to comment.