mirror/openmw
1
0
Fork 0
mirror of https://github.com/OpenMW/openmw.git synced 2025-11-04 01:56:44 +00:00
Code Issues Releases Wiki Activity
openmw/docs/source
History
elsid bb7e40bfd8
Support generating Lua API reference from self-built docker container
2022-07-12 01:08:42 +02:00
..
_static Integrate Lua doc into sphinx doc (issue #5931) 2021-07-09 20:48:54 +02:00
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 Integrate Lua doc into sphinx doc (issue #5931) 2021-07-09 20:48:54 +02:00
Dockerfile.luadoc 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
generate_luadoc_in_docker.sh Support generating Lua API reference from self-built docker container 2022-07-12 01:08:42 +02:00
index.rst Revert "Revert "remove breath/doxygen autodoc"" 2018-07-19 23:27:39 +02:00
README.md Support generating Lua API reference from self-built docker container 2022-07-12 01:08:42 +02:00
tutorial-style-guide.txt Converted all settings files to semantic linefeeds. 2017-05-14 22:04:20 -07:00

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