MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
dfhack/docs/Scripts.rst

18 lines
393 B
ReStructuredText
Raw Normal View History Unescape Escape

Split readme into files for scripts, plugins, and base The plugin docs are still a mess, but the base and scripts are now close to manageable.
2015-09-22 07:30:22 -06:00
##############
DFHack Scripts
##############
Clean up other docs to match Some deduplication in Scripts and Plugins, links in NEWS, add content and link to files in index.
2015-11-05 06:59:48 -07:00
Lua or ruby scripts placed in the :file:`hack/scripts/` directory
are considered for execution as if they were native DFHack commands.
Split readme into files for scripts, plugins, and base The plugin docs are still a mess, but the base and scripts are now close to manageable.
2015-09-22 07:30:22 -06:00
Clean up other docs to match Some deduplication in Scripts and Plugins, links in NEWS, add content and link to files in index.
2015-11-05 06:59:48 -07:00
The following pages document all the scripts in the DFHack standard library.
Split readme into files for scripts, plugins, and base The plugin docs are still a mess, but the base and scripts are now close to manageable.
2015-09-22 07:30:22 -06:00
Much improved script docs generator Creates a single file for each kind of script (base, gui, fix...). This includes and correctly sorts content from any .lua or .rb file under the scripts directory. It's more robust and more readable than the old style, and doesn't write anything in the submodules. User-added scripts will be seamlessly added, if they have a docs section and Sphinx is run.
2015-10-23 05:25:04 -06:00
.. toctree::
:maxdepth: 2
Updated docs linter for scripts Also made scripts toctree more explicit
2015-10-24 00:00:54 -06:00
/docs/_auto/base
/docs/_auto/devel
/docs/_auto/fix
/docs/_auto/gui
/docs/_auto/modtools