mirror/openmw
1
0
Fork 0
mirror of https://github.com/OpenMW/openmw.git synced 2025-01-30 08:45:33 +00:00
Code Issues Releases Wiki Activity
openmw/docs
History
AnyOldName3 66b8d4fb29 Add a setting to control coverage adjustment 
With it on, which was always the case before this setting was added,
vanilla content and poorly-made mods will look acceptable, but well-made
mods will have alpha-tested meshes appear to grow and potentially gain a
weird outline as they get further away.

With it off, which replicates the 0.46 behaviour, well-made mods will
look really good, but vanilla content and poorly-made mods will have
alpha-tested meshes shrink as they get further away.

It's been bugging me that this was forced on since 0.47 released, and
I'd hoped to figure out a solution for automatic detection at some point
before 0.48 branched off, but I didn't, so now this is what we're
getting to have Tamriel Rebuilt look right.
2022-12-09 00:22:08 +00:00
..
source Add a setting to control coverage adjustment 2022-12-09 00:22:08 +00: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 http to https for supported urls (#1625) 2018-03-08 21:23:24 +01:00
DoxyfilePages.cmake http to https for supported urls (#1625) 2018-03-08 21:23:24 +01:00
mainpage.hpp.cmake Task #940: Move licenses to appropriate place in docs. Additional cleanup. 2014-06-10 11:25:39 +02:00
openmw-stage1.md stage1: priorities for event music and other minor improvements to the music system 2018-07-24 12:57:09 +02:00
prepare_docker_image.sh An easy way to build OpenMW documentation in docker 2022-08-09 09:29:02 +00:00
README.md An easy way to build OpenMW documentation in docker 2022-08-09 09:29:02 +00:00
requirements.txt An easy way to build OpenMW documentation in docker 2022-08-09 09:29:02 +00: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.1.1-1.rockspec
luarocks --local install openmwluadocumentor-0.1.1-1.src.rock

Windows

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

Generating HTML

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

sphinx-build docs/source docs/build