mirror of
https://gitlab.com/OpenMW/openmw.git
synced 2025-01-17 10:10:23 +00:00
19 lines
563 B
Markdown
19 lines
563 B
Markdown
|
# Source files for OpenMW documentation
|
||
|
|
|
||
|
|
## Generating Lua scripting API reference
|
||
|
|
|
||
|
|
### Building Docker image
|
||
|
|
|
||
|
|
Run following command from OpenMW source directory to build a new Docker image `openmw.luadoc`:
|
||
|
|
```bash
|
||
|
|
docker build -f docs/source/Dockerfile.luadoc -t openmw.luadoc docs/source
|
||
|
|
```
|
||
|
|
|
||
|
|
### Generating HTML
|
||
|
|
|
||
|
|
Run following command from OpenMW source directory to generate HTML pages:
|
||
|
|
```bash
|
||
|
|
docker run --rm --tty --interactive --user "$(id -u)":"$(id -g)" \
|
||
|
|
--volume "${PWD}":/openmw openmw.luadoc /openmw/docs/source/generate_luadoc_in_docker.sh
|
||
|
|
```
|