MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Final documentation changes 

Squashes a couple of commits from the other branch onto the last one
here.
develop
PeridexisErrant 2015-09-26 16:50:02 +10:00
parent 2302698b22
commit e92d63d248
6 changed files with 27 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
NEWS
Unescape Escape View File

@ -1,8 +1,8 @@
.. comment
This is the changelog file for DFHack. If you add or change anything, note
it here under the heading "DFHack Future", in the appropriate section.
Items within each section are listed in order of addition. Try to match the
style and level of detail of the other entries.
Items within each section are listed in alphabetical order to minimise merge
conflicts. Try to match the style and level of detail of the other entries.
DFHack Future

6
README.html
Unescape Escape View File

@ -4,13 +4,13 @@
<html lang="en-US">
<head>
<meta charset="UTF-8">
<meta http-equiv="refresh" content="0;url=./docs/_build/html/README.html">
<meta http-equiv="refresh" content="0;url=./docs/html/README.html">
<script type="text/javascript">
window.location.href = "./docs/_build/html/README.html"
window.location.href = "./docs/html/README.html"
</script>
<title>Page Redirection</title>
</head>
<body>
If you are not redirected automatically, follow the <a href='./docs/_build/html/README.html'>link to the documentation.</a>
If you are not redirected automatically, follow the <a href='./docs/html/README.html'>link to the documentation.</a>
</body>
</html>

6
docs/Authors.rst
Unescape Escape View File

@ -5,9 +5,9 @@ particular order.
If you should be here and aren't, please get in touch or make a pull request!
======================= ==================== ===========================
======================= ======================= ===========================
Name Github Email
======================= ==================== ===========================
======================= ======================= ===========================
Petr Mrázek peterix peterix@gmail.com
Alexander Gavrilov angavrilov angavrilov@gmail.com
doomchild doomchild lee.crabtree@gmail.com
@ -86,4 +86,4 @@ Vjek
Kris Parker kaypy
Jonas Ask jonask84@gmail.com
8Z 8Z git8z@ya.ru
======================= ==================== ===========================
======================= ======================= ===========================

3
docs/Binpatches.rst
Unescape Escape View File

@ -55,7 +55,8 @@ script uses ``hack/patches/<df-version>/<name>.dif``, thus auto-selecting
the version appropriate for the currently loaded executable.
This is the preferred method; it's easier to debug, does not cause persistent
problems, and leaves file checksums alone.
problems, and leaves file checksums alone. As with many other commands, users
can simply add it to ``dfhack.init`` to reapply the patch every time DF is run.
Patching on disk

2
docs/Plugins.rst
Unescape Escape View File

@ -2197,6 +2197,8 @@ Examples:
* You switch to the adventure game mode, assume control of a creature, then save or retire.
* You just created a returnable mountain home and gained an adventurer.
.. _plugins/strangemood:
strangemood
===========
Creates a strange mood job the same way the game itself normally does it.

18
docs/Scripts.rst
Unescape Escape View File

@ -23,12 +23,24 @@ the next instruction.
This listing is autogenerated from ``.rst`` files in the 3rdparty scripts directory.
.. warning::
Because this documentation is pulled in from external sources,
it may not match the DFHack distribution exactly.
* Some scripts should have a prefix (eg listed as ``myscript``,
should be ``gui/myscript``) but don't.
* Some sections of documentation may refer to scripts which are
not distributed with DFHack.
.. toctree::
:glob:
:maxdepth: 2
/scripts/3rdparty/*/*
=======
devel/*
=======
@ -649,7 +661,7 @@ Runs `plugins/autolabor`, with settings tuned for small but highly skilled workf
autounsuspend
=============
Automatically unsuspend construction jobs, on a recurring basis.
Automatically unsuspend jobs in workshops, on a recurring basis.
See `scripts/unsuspend` for one-off use, or `plugins/resume` ``all``.
ban-cooking
@ -1205,8 +1217,8 @@ Undesignates building base materials for dumping.
unsuspend
=========
Unsuspend construction jobs, on a one-off basis. See `scripts/autounsuspend` for regular use.
Equivalent to `plugins/resume` ``all``.
Unsuspend jobs in workshops, on a one-off basis. See `scripts/autounsuspend`
for regular use.
.. _scripts/view-item-info: