Skip to content

docs: rename Documentation generation command to ALE #353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iThorgrim merged 2 commits into from
Jan 9, 2026
Merged

docs: rename Documentation generation command to ALE #353

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9df8691
docs: update doc/ generator command
sogladev Jan 8, 2026
6bc7309
Merge branch 'master' into docs
sogladev Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/LuaEngine/docs/DOC_GEN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Documentation generation
Eluna uses a custom made documentation generator to create it's [web documentation](http://elunaluaengine.github.io/).
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.

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/)
Expand All @@ -14,7 +14,7 @@ This page guides you through generating the web documentation locally and explai
- [Jinja2](https://pypi.python.org/pypi/Jinja2)
- [typedecorator](https://pypi.python.org/pypi/typedecorator)
- [markdown](https://pypi.python.org/pypi/Markdown)
- Run in cmd `python -m ElunaDoc` when at `\LuaEngine\docs\`
- Run in cmd `python -m ALEDoc` when at `\LuaEngine\docs\`

# Documenting
You can document functions in the Eluna source code. To find examples simply open a method header file like `PlayerMethods.h` and see the comments.
Expand Down