Urbanotopus Game and Docs
Game sources and documentation for Urbanotopus.
Download links
You will find the latest download link here (for Windows, Linux, Mac, Android and iOS). And a browser demo (WebGL) here.
Other links
Documentation
Contenu
How to build the docs
Hand written documentation (sphinx)
Installation of the requirements
- Install Python 3.7;
- Create and activate a python virtual environment;
- Install the requirements through
pip install -r requirements.txt
;
- (Optional) Edit the files under the docs folder;
Building the sphinx documentation
- Build or rebuild the docs by running
make html
in the root project directory;
- Open your web-browser to
build/html/index.html
.
Source code documentation (doxygen)
Installation of the requirements
Install doxygen through this link or using your preferred Unix package manager.
Generating the doxygen documentation
- Build or rebuild by running
doxygen
in the root project directory.
- Open your web-browser to
html/index.html
.
Resources