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

44 lines
1.2 KiB
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
##############
Lua or ruby scripts placed in the ``hack/scripts/`` directory are considered for
execution as if they were native DFHack commands. They are listed at the end
More internal links and consistent formatting Links everywhere, and formatting throughout Plugins.rst
2015-09-24 22:15:05 -06:00
of the ``ls`` command output.
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
Note: scripts in subdirectories of hack/scripts/ can still be called, but will
More internal links and consistent formatting Links everywhere, and formatting throughout Plugins.rst
2015-09-24 22:15:05 -06:00
only be listed by ls if called as ``ls -a``. This is intended as a way to hide
scripts that are obscure, developer-oriented, or should be used as keybindings
Explain script type at top of listing Using an `about.txt` file in each directory. This is nice because it keeps the purpose notes in the actual script directories.
2015-10-24 00:41:21 -06:00
or from the init file. See the page for each type for details.
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
``kill-lua`` stops any currently-running Lua scripts. By default, scripts can
only be interrupted every 256 instructions. Use ``kill-lua force`` to interrupt
the next instruction.
Autogen script links, table of contents, and demo! Automatically generating the link target for each script saves a lot of time and potential for errors. Each kind-of-script page now includes a link target for that page, and also a table of contents. In-script markers to delimit text for Sphinx extraction now use native docstring markers from Ruby, which is a lot more elegant in .rb scripts - and robust, as long as the fisrt docstring is valid .rst!
2015-10-23 07:33:35 -06:00
The following pages document all the standard DFHack scripts.
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
Final documentation changes Squashes a couple of commits from the other branch onto the last one here.
2015-09-26 00:50:02 -06:00
Clean up .travis.yml
2015-09-26 18:04:42 -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
.. warning::
Final documentation changes Squashes a couple of commits from the other branch onto the last one here.
2015-09-26 00:50:02 -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
The following documentation is pulled in from external ``README`` files.
- it may not match the DFHack docs style
- some scripts have incorrect names, or are documented but unavailable
- some scripts have entries here and are also included above
Final documentation changes Squashes a couple of commits from the other branch onto the last one here.
2015-09-26 00:50:02 -06:00
Add listing of 3rdparty scripts, in Scripts doc This will automatically find any .rst documentation matching the pattern, and include it.
2015-09-24 04:21:05 -06:00
.. toctree::
:glob:
:maxdepth: 2
Updated docs linter for scripts Also made scripts toctree more explicit
2015-10-24 00:00:54 -06:00
/scripts/3rdparty/*/README
Add listing of 3rdparty scripts, in Scripts doc This will automatically find any .rst documentation matching the pattern, and include it.
2015-09-24 04:21:05 -06:00