You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
openmw/docs
uramer 9cce2e39ba Merge branch 'master' into menuscripts 11 months ago
..
source Merge branch 'master' into menuscripts 11 months ago
Dockerfile An easy way to build OpenMW documentation in docker 2 years ago
Doxyfile.cmake http to https for supported urls (#1625) 7 years ago
DoxyfilePages.cmake http to https for supported urls (#1625) 7 years ago
README.md updateluadocumentor 2 years ago
build_docs.sh An easy way to build OpenMW documentation in docker 2 years ago
mainpage.hpp.cmake Task #940: Move licenses to appropriate place in docs. Additional cleanup. 11 years ago
openmw-stage1.md stage1: priorities for event music and other minor improvements to the music system 7 years ago
prepare_docker_image.sh An easy way to build OpenMW documentation in docker 2 years ago
requirements.txt An easy way to build OpenMW documentation in docker 2 years ago
tlconfig.lua Generate Teal declarations from luadoc 2 years ago

README.md

Building OpenMW documentation

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

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