mirror of https://gitlab.com/OpenMW/openmw.git synced 2024-12-29 12:20:41 +00:00

History

Elias Howell bf8fafa79a fixed some typos and spelling errors		2023-05-09 20:07:08 -04:00
..
source	fixed some typos and spelling errors	2023-05-09 20:07:08 -04:00
build_docs.sh	An easy way to build OpenMW documentation in docker	2022-08-09 09:29:02 +00:00
Dockerfile	An easy way to build OpenMW documentation in docker	2022-08-09 09:29:02 +00:00
Doxyfile.cmake
DoxyfilePages.cmake
mainpage.hpp.cmake
openmw-stage1.md
prepare_docker_image.sh	An easy way to build OpenMW documentation in docker	2022-08-09 09:29:02 +00:00
README.md	updateluadocumentor	2023-01-04 17:26:04 +08:00
requirements.txt	An easy way to build OpenMW documentation in docker	2022-08-09 09:29:02 +00:00
tlconfig.lua	Generate Teal declarations from luadoc	2023-02-11 12:51:58 +01:00

README.md

Building OpenMW documentation

Building in Docker (the recommended way)

Preparing Docker image

Run the following commands from OpenMW source directory to build a new Docker image openmw_doc:

cd docs
docker build -t openmw_doc .
cd ..

(or run script docs/prepare_docker_image.sh)

This step needs to be repeated only if any dependencies were changed.

The image is based on readthedocs/build:latest that is newer than the image readthedocs uses by default (readthedocs/build:stable). So if after some readthedocs update the documentation will stop building, there is a chance to detect it before the online docs will break.

Generating HTML

Run the following command from OpenMW source directory to generate the documentation:

docker run --user "$(id -u)":"$(id -g)" --volume "$PWD":/openmw openmw_doc \
    sphinx-build /openmw/docs/source /openmw/docs/build

(or run script docs/build_docs.sh)

To view the generated documentation just open docs/build/index.html in a browser.

Building without Docker (an alternative way)

Building documentation without Docker is more complicated as it requires multiple dependencies.

Installation of required python packages

From OpenMW source directory

pip3 install -r docs/requirements.txt

Installation of openmwluadocumentor:

Debian/Ubuntu

sudo apt install luarocks
git clone https://gitlab.com/ptmikheev/openmw-luadocumentor.git
cd openmw-luadocumentor/luarocks
luarocks --local pack openmwluadocumentor-0.2.0-1.rockspec
luarocks --local install openmwluadocumentor-0.2.0-1.src.rock

Windows

install LuaRocks (heavily recommended to use the standalone package) https://github.com/luarocks/luarocks/wiki/Installation-instructions-for-Windows
git clone https://gitlab.com/ptmikheev/openmw-luadocumentor.git
cd openmw-luadocumentor/luarocks
open "Developer Command Prompt for VS <2017/2019>" in this directory and run:

luarocks --local pack openmwluadocumentor-0.2.0-1.rockspec
luarocks --local install openmwluadocumentor-0.2.0-1.src.rock

Generating HTML

Run the following command from OpenMW source directory to generate the documentation:

sphinx-build docs/source docs/build