Update DOC_GEN.md

This commit is contained in:
Rochet2
2017-03-15 23:54:15 +02:00
committed by GitHub
parent d5f0db1335
commit 8d3433f4b5

View File

@@ -1,5 +1,5 @@
# Documentation generation # Documentation generation
Eluna uses a custom made documentation generator to create it's [web documentation](http://eluna.emudevs.com/). Eluna uses a custom made documentation generator to create it's [web documentation](http://elunaluaengine.github.io/).
The generator is written in python by Patman. It works by parsing Eluna's source files for comments and then generates the HTML and javascript for the documentation based on them. The generator is written in python by Patman. It works by parsing Eluna's source files for comments and then generates the HTML and javascript for the documentation based on them.
This page guides you through generating the web documentation locally and explains the standards of the documentation comments for you to help us improve our documentation. To contribute with your documentation changes, create a [pull request](https://help.github.com/articles/using-pull-requests/) This page guides you through generating the web documentation locally and explains the standards of the documentation comments for you to help us improve our documentation. To contribute with your documentation changes, create a [pull request](https://help.github.com/articles/using-pull-requests/)