Skip to content

Commit 6ea7852

Browse files
committed
Remove auto-documentation
1 parent 726a719 commit 6ea7852

File tree

12 files changed

+1
-450
lines changed

12 files changed

+1
-450
lines changed

.github/workflows/doc.yml

Lines changed: 0 additions & 34 deletions
This file was deleted.

.vscode/tasks.json

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,6 @@
1212
"reveal": "silent",
1313
}
1414
},
15-
{
16-
"label": "Build html",
17-
"type": "shell",
18-
"problemMatcher": [],
19-
"command": "sphinx-build -b html predocs docs/_build/html",
20-
"args": [""],
21-
"group": "build",
22-
"presentation": {
23-
"reveal": "silent",
24-
}
25-
},
2615
{
2716
"label": "Handle sounds",
2817
"type": "shell",

README.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,6 @@
3535
<a href="changelog.txt">Changelog</a>
3636
·
3737
<a href="https://crowdin.com/project/factorio-mods-localization">Translations</a>
38-
.
39-
<a href="https://zweroxotnik.github.io/factorio-example-mod/">Documentation</a>
4038
</p>
4139

4240
<h1></h1>
@@ -66,7 +64,6 @@ What it can do
6664
* Use modular structure
6765
* Remotely and safely disable your mod
6866
* Publish your mod on mod portal via GitHub tags
69-
* Auto generate documentation with auto publishing on [GitHub pages][GitHub-page]
7067
* Auto publishing on [mods.portal.com](https://mods.factorio.com/) and on GitHub
7168

7269
What it enables you to do
@@ -79,7 +76,6 @@ What it enables you to do
7976
* More possibilities to control logic
8077
* Quickly publish your mod on mod portal
8178
* Use other's modules/code without adaptation
82-
* Easily manage your documentation
8379
* Auto publishing everywhere (almost)
8480
* Easy maintaining
8581

@@ -103,14 +99,13 @@ Stuff used
10399
* [Lua Language Server](https://github.com/sumneko/lua-language-server) ([Setting without VSCode](https://github.com/sumneko/lua-language-server/wiki/Setting-without-VSCode))
104100
* [EmmyLua Annotation][EmmyLua-Annotations]
105101
* Some ZwerOxotnik's code
106-
* Auto documentation: [GitHub actions](.github/workflows/doc.yml) + [Python](https://www.python.org/) + [sphinx] + extensions (more details in [predocs/predocs.md](predocs/predocs.md))
107102
* [factorio-mod-luacheck][factorio-mod-luacheck] - This GitHub action will run your mod code through luacheck (not full support)
108103
* Auto publishing using many GitHub actions etc (see [.github/workflows/autoPublish.yml](.github/workflows/autoPublish.yml))
109104

110105
Additional stuff
111106
----------------
112107

113-
* [FactorioSumnekoLuaPlugin](https://github.com/JanSharp/FactorioSumnekoLuaPlugin) - a plugin for the [sumneko.lua vscode extension](https://github.com/sumneko/lua-language-server) to help with factorio related syntax and intelisense. (there's no compability with auto documentation)
108+
* [FactorioSumnekoLuaPlugin](https://github.com/JanSharp/FactorioSumnekoLuaPlugin) - a plugin for the [sumneko.lua vscode extension](https://github.com/sumneko/lua-language-server) to help with factorio related syntax and intelisense.
114109
* [LuaFormatter](https://github.com/Koihik/LuaFormatter) - reformats your Lua source code (supports several editors)
115110
* Try another example with preprocessor in lua: https://github.com/ZwerOxotnik/factorio-candran-example
116111

@@ -125,7 +120,6 @@ How to start?
125120
* **Change or delete** .github/workflows/* (please read [this](https://github.com/shanemadden/factorio-mod-portal-publish))
126121
* Handle files in [control.lua](control.lua)
127122
* Change settings in [models/BetterCommands/control.lua](models/BetterCommands/control.lua) if you want
128-
* Change/delete auto documentation in ./predocs and [doc.yml](.github/workflows/doc.yml)
129123

130124
Notes
131125
-----
@@ -144,7 +138,6 @@ Next updates
144138
* More examples of particular cases on all stages
145139
* Support of [SimpleAPI](https://mods.factorio.com/mod/diplomacy/discussion/60c1eb9177457f7dd7943e14) (diplomacy, money, chat, etc)
146140
* Probably, I'll add [factorio-mod-luacheck]
147-
* Improve documentation
148141
* Etc
149142

150143
Requirements
@@ -222,8 +215,4 @@ SOFTWARE.
222215
[GitHub-page]: https://zweroxotnik.github.io/factorio-example-mod/
223216
[git]: https://git-scm.com/downloads
224217
[factorio-mod-luacheck]: https://github.com/Roang-zero1/factorio-mod-luacheck
225-
[sphinx]: https://www.sphinx-doc.org/en/master/
226218
[EmmyLua-Annotations]: https://github.com/sumneko/lua-language-server/wiki/EmmyLua-Annotations
227-
[m2r2]: https://github.com/crossnox/m2r2
228-
[sphinx-rtd-theme]: https://github.com/readthedocs/sphinx_rtd_theme
229-
[sphinx-lua]: https://github.com/boolangery/sphinx-lua

predocs/BetterCommands.rst

Lines changed: 0 additions & 12 deletions
This file was deleted.

predocs/ExampleModule.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

predocs/ModuleStructure.lua

Lines changed: 0 additions & 31 deletions
This file was deleted.

predocs/_static/.keep

Whitespace-only changes.

0 commit comments

Comments
 (0)