This is the official repository for Crea's modding documentation. The contents include the core documentation as well as tutorials and anything else related to helping Crea modders. I plan to build onto this over time but wanted to open it up for anyone to contribute.
You want to contribute? Great! Please follow the standard forking and sending pull requests procedures. The goal is to get the documentation close to something like Python's Documentation. Consequently, it is highly recommended to read their documentation guide.
This documentation is built using Sphinx. Their site is a great source for learning how to work with Sphinx. You also will need sphinx-bootstrap-theme. To easily install both, via pip, run these two commands:
pip install -U Sphinx
pip install -U sphinx_bootstrap_theme
One thing to note is that the src/api folder is generated from the engine source and consequently should not be edited directly. If there are changes you'd like to suggest for these files then create an issue or contact me directly.
Run 'make html' and the output will be placed into build/.