mirror of
https://github.com/azerothcore/mod-ale
synced 2025-11-29 15:38:17 +08:00
Add doc gen instructions
This commit is contained in:
@@ -12,7 +12,7 @@ namespace LuaSpell
|
||||
/**
|
||||
* Returns 'true' if the &Spell is automatically repeating, false otherwise.
|
||||
*
|
||||
* @return boolean isAutoRepeating
|
||||
* @return bool isAutoRepeating
|
||||
*/
|
||||
int IsAutoRepeat(lua_State* L, Spell* spell)
|
||||
{
|
||||
|
||||
15
docs/DOC_GEN.md
Normal file
15
docs/DOC_GEN.md
Normal file
@@ -0,0 +1,15 @@
|
||||
#Documentation generation
|
||||
|
||||
##Setting up
|
||||
- install [python](https://www.python.org/)(2)
|
||||
- when installing, tick to install the path variable
|
||||
- may need restart after for installation to properly take effect
|
||||
- install a package manager like [pip](https://pip.pypa.io/en/latest/)
|
||||
- if installed pip and doesnt work, restart or try easy_install command
|
||||
- install the dependencies with manager
|
||||
- [Jinja2](https://pypi.python.org/pypi/Jinja2)
|
||||
- [typedecorator](https://pypi.python.org/pypi/typedecorator)
|
||||
- [markdown](https://pypi.python.org/pypi/Markdown)
|
||||
|
||||
##Generating
|
||||
- Run in cmd `python -m ElunaDoc` when at `\LuaEngine\docs\`
|
||||
Reference in New Issue
Block a user