mirror of https://gitlab.com/OpenMW/openmw.git synced 2025-01-16 16:10:58 +00:00

History

elsid bb7e40bfd8 Support generating Lua API reference from self-built docker container		2022-07-12 01:08:42 +02:00
..
_static
manuals	Fix links to the wiki	2022-07-01 15:38:38 +02:00
reference	Remove this line	2022-07-04 18:08:08 +00:00
conf.py
Dockerfile.luadoc	Support generating Lua API reference from self-built docker container	2022-07-12 01:08:42 +02:00
generate_luadoc_in_docker.sh	Support generating Lua API reference from self-built docker container	2022-07-12 01:08:42 +02:00
generate_luadoc.sh	Control camera settings in-game	2022-06-12 00:06:39 +02:00
index.rst
README.md	Support generating Lua API reference from self-built docker container	2022-07-12 01:08:42 +02:00
tutorial-style-guide.txt

README.md

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:

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:

docker run --rm --tty --interactive --user "$(id -u)":"$(id -g)" \
    --volume "${PWD}":/openmw openmw.luadoc /openmw/docs/source/generate_luadoc_in_docker.sh