You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-31Lines changed: 3 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,8 +78,9 @@ What it enables you to do
78
78
* More possibilities to control logic
79
79
* Fastly publish your mod on mod portal
80
80
* Use other's modules/code without adaptation
81
-
* Easily manage your documenation
81
+
* Easily manage your documentation
82
82
* Auto publishing everywhere (almost)
83
+
* Easy maintaining
83
84
84
85
Useful stuff
85
86
------------
@@ -100,7 +101,7 @@ Stuff used
100
101
*[Lua Language Server](https://github.com/sumneko/lua-language-server) ([Setting without VSCode](https://github.com/sumneko/lua-language-server/wiki/Setting-without-VSCode))
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
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