Skip to content

Commit 6f3feab

Browse files
committed
Update to 0.3.2
1 parent 0926f03 commit 6f3feab

File tree

5 files changed

+38
-33
lines changed

5 files changed

+38
-33
lines changed

README.md

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,9 @@ What it enables you to do
7878
* More possibilities to control logic
7979
* Fastly publish your mod on mod portal
8080
* Use other's modules/code without adaptation
81-
* Easily manage your documenation
81+
* Easily manage your documentation
8282
* Auto publishing everywhere (almost)
83+
* Easy maintaining
8384

8485
Useful stuff
8586
------------
@@ -100,7 +101,7 @@ Stuff used
100101
* [Lua Language Server](https://github.com/sumneko/lua-language-server) ([Setting without VSCode](https://github.com/sumneko/lua-language-server/wiki/Setting-without-VSCode))
101102
* [EmmyLua Annotation][EmmyLua-Annotations]
102103
* Some ZwerOxotnik's code
103-
* Auto documentation: [GitHub actions](.github/workflows/doc.yml) + [Python](https://www.python.org/) + [sphinx][sphinx] + [sphinx-lua][sphinx-lua] + [sphinx-rtd-theme][sphinx-rtd-theme] + [m2r2][m2r2]
104+
* Auto documentation: [GitHub actions](.github/workflows/doc.yml) + [Python](https://www.python.org/) + [sphinx][sphinx] + extensions (more details in [predocs/predocs.md](predocs/predocs.md))
104105
* [factorio-mod-luacheck][factorio-mod-luacheck] - This GitHub action will run your mod code through luacheck (not full support)
105106
* Auto publishing using many GitHub actions etc (see [.github/workflows/autoPublish.yml](.github/workflows/autoPublish.yml))
106107

@@ -156,35 +157,6 @@ git clone --recurse-submodules -j8 https://github.com/ZwerOxotnik/factorio-examp
156157
cd example-mod
157158
```
158159

159-
About auto documentation
160-
------------------------
161-
162-
It uses [emmylua](https://emmylua.github.io/annotations/class.html) as primary doc syntax but it is also compatible with some [ldoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html) tags.
163-
164-
All configurations are stored in `predocs` folder.
165-
166-
Please, use Python 3.6 to use these tools.
167-
168-
Manual installation:
169-
170-
```bash
171-
pip install -r requirements.txt
172-
```
173-
174-
Building html:
175-
176-
```bash
177-
sphinx-build -b html predocs docs/_build/html
178-
```
179-
180-
Dependencies:
181-
182-
* [sphinx][sphinx] - Sphinx is a tool that makes it easy to create intelligent and beautiful documentation
183-
* sphinxcontrib-luadomain - A sphinx lua domain.
184-
* [sphinx-lua][sphinx-lua] - Generates a [sphinx][sphinx] doc using lua doc comment.
185-
* [sphinx-rtd-theme][sphinx-rtd-theme] - A theme for [sphinx][sphinx]
186-
* [m2r2][m2r2] - Markdown to reStructuredText converter
187-
188160
[Contributing](/CONTRIBUTING.md)
189161
--------------------------------
190162

changelog.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
---------------------------------------------------------------------------------------------------
2+
Version: 0.3.2
3+
Date: 2021-07-10
4+
Changes:
5+
- Minor changes
6+
---------------------------------------------------------------------------------------------------
27
Version: 0.3.1
38
Date: 2021-07-08
49
Changes:

control.lua

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,9 @@ if remote.interfaces["disable-" .. script.level.mod_name] then
2828
module.on_configuration_changed = update_global_data_on_disabling
2929
module.on_init = update_global_data_on_disabling
3030
end
31+
else
32+
modules.better_commands:handle_custom_commands(modules.example_module) -- adds commands
3133
end
3234

33-
modules.better_commands:handle_custom_commands(modules.example_module) -- adds commands
3435

3536
event_handler.add_libraries(modules)

info.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "example-mod",
3-
"version": "0.3.1",
3+
"version": "0.3.2",
44
"factorio_version": "1.1",
55
"title": "Example mod",
66
"author": "Put your nickname",

predocs/predocs.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# About auto documentation
2+
3+
It uses [emmylua](https://emmylua.github.io/annotations/class.html) as primary doc syntax but it is also compatible with some [ldoc](https://stevedonovan.github.io/ldoc/manual/doc.md.html) tags.
4+
5+
All configurations are stored in `predocs` folder.
6+
7+
Please, use Python 3.6 to use these tools.
8+
9+
Manual installation:
10+
11+
```bash
12+
pip install -r requirements.txt
13+
```
14+
15+
Building html:
16+
17+
```bash
18+
sphinx-build -b html predocs docs/_build/html
19+
```
20+
21+
Dependencies:
22+
23+
* [sphinx][sphinx] - Sphinx is a tool that makes it easy to create intelligent and beautiful documentation
24+
* sphinxcontrib-luadomain - A sphinx lua domain.
25+
* [sphinx-lua][sphinx-lua] - Generates a [sphinx][sphinx] doc using lua doc comment.
26+
* [sphinx-rtd-theme][sphinx-rtd-theme] - A theme for [sphinx][sphinx]
27+
* [m2r2][m2r2] - Markdown to reStructuredText converter

0 commit comments

Comments
 (0)