Commit Graph

133 Commits (a60e525a5c6ebc148bed1880e0b4bf7a0d5ea84f)

Author SHA1 Message Date
PeridexisErrant a4708d07a1 Allow Sphinx-doc to work with or without cmake
This mainly involved tweaking a few filenames and configuration paths to
allow consistency in all scenarios.  It cleared up a few errors in the
process too!

I also clarified the placement of the LICENSE file, and finished
configuring the Alabaster style.  This required moving some stuff out of
the CMake system to conf.py to avoid later breakage.
2015-10-23 12:34:54 +11:00
PeridexisErrant c5d6e693f8 Use command name only for internal hyperlinks
Because it's not actually that important to the user how a command is
implemented, and the docs should reflect that.  This also makes them
easier to write!
2015-10-19 14:16:19 +11:00
PeridexisErrant a091ba4a70 Use .rst format for NEWS directly 2015-10-15 18:43:25 +11:00
PeridexisErrant 2302698b22 Consolidate binpatch docs. Closes #546
Binpatches aren't used much at the moment, so this has two purposes:
collate information so it's easier to write them again, and remove it
from other sections where it's useless.

Note that if the standalone binpatch.exe is removed, the 'patching on
disk' section can be cleanly removed from 'Using a patch' by deleting
lines 44-47 & 61-90.
2015-09-26 12:28:09 +10:00
PeridexisErrant 00a261cc81 More internal links and consistent formatting
Links everywhere, and formatting throughout Plugins.rst
2015-09-26 12:28:07 +10:00
PeridexisErrant f25694d745 Only have one file named Readme 2015-09-26 12:28:07 +10:00
PeridexisErrant e7cf96d12e Format LICENSE - minimal content changes
No changes whatsoever are made to the licenses.  Formatting is
consistent.  Comments are cleaned up a little.  Some quotation marks are
consistent.  Added link target and links.
2015-09-26 12:28:06 +10:00
PeridexisErrant 2c2406727f More consistent formatting
Eg use of monospaced font, line length, internal links, added xml SYNTAX
to root table of contents.
2015-09-26 12:28:05 +10:00
PeridexisErrant 5ba656bf79 Include changelog and licenses in generated docs
We may want to use .rst formatting for these eventually, and maybe move
the NEWS file to docs/News.rst and docs/History.rst - but for now
including the raw text works well enough.
2015-09-23 11:03:26 +10:00
PeridexisErrant 9d1baac6a0 Note issue with multidimensional arrays in lua
Closes #597.  Also remove old TODO in readme.
2015-09-23 10:38:46 +10:00
PeridexisErrant 8141de869b 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 23:30:22 +10:00
PeridexisErrant eb5286dd86 Misc changes for better structure 2015-09-22 18:42:15 +10:00
PeridexisErrant 336f8ee611 Name index.rst -> README.rst for Github integration 2015-09-22 18:26:56 +10:00
Petr Mrázek 8812238bf6 Update license, add contributors file, bump release number 2012-09-30 04:03:37 +02:00
Alexander Gavrilov 62cde96724 Add a script to reclassify 'individual choice' weapons based on unit skill. 2012-09-29 17:21:49 +04:00
Alexander Gavrilov cb2acc169c Edit docs. 2012-09-29 13:17:28 +04:00
Petr Mrázek cd18660f0e Add documentation for added plugins - digtype, misery, changes in fastdwarf 2012-09-29 02:58:30 +02:00
Alexander Gavrilov ba763b773d New tweaks for the military assign to position screen. 2012-09-28 18:01:17 +04:00
Alexander Gavrilov bd7cd690aa Implement the common suggestion of Shift-Enter in trade screens. 2012-09-28 13:32:41 +04:00
Alexander Gavrilov 7e0365857d Edit docs a bit more. 2012-09-27 11:19:28 +04:00
Alexander Gavrilov 627f036830 Implement a special command parsing mode with one verbatim argument.
Intended for script expressions, e.g. rb_eval.
2012-09-24 19:13:33 +04:00
jj b665c344da add deathcause to README 2012-09-23 23:37:57 +02:00
jj 962a057ffa Merge branch 'master' of git://github.com/angavrilov/dfhack 2012-09-23 23:31:05 +02:00
Alexander Gavrilov 825d21c91a Add a script to wake up units and stop breaks & parties. 2012-09-22 21:00:13 +04:00
Alexander Gavrilov c5101b2ea4 Group commands in the readme document by their general type.
There are way too many of them now for a flat list to work.
2012-09-21 12:19:48 +04:00
Alexander Gavrilov 1403bb126c README: move keybinding to the start and add a section for scripts. 2012-09-20 15:38:58 +04:00
Alexander Gavrilov e2d6a14720 Make manipulator re-read names and professions if change is suspected.
Namely, if it either invoked View Unit itself, or was queried
(possibly by the rename plugin) via getSelectedUnit.
2012-09-20 12:27:03 +04:00
Alexander Gavrilov 1f7c10252e Support renaming activity zones.
This one required hooking the dwarfmode render method.
2012-09-20 11:48:53 +04:00
Alexander Gavrilov 0c260d5352 Tweak README some more. 2012-09-19 20:10:28 +04:00
Quietust 19e1711a2f Several Manipulator updates
* Add documentation to README, cleanup some docs for other plugins
* Preserve existing unit list order and cursor/scroll position
* Adjust mouse input handling, don't move cursor on left-click
2012-09-19 10:20:18 -05:00
jj 27fd3f5fc7 Merge branch 'master' of git://github.com/angavrilov/dfhack 2012-09-19 15:05:42 +02:00
Alexander Gavrilov 65a382a2d7 Document some of the new stuff in the readme. 2012-09-19 15:55:08 +04:00
jj cc4639aad0 update NEWS/README with drainaquifer/superdwarf 2012-09-18 10:29:58 +02:00
jj 7b86f203c3 add script/digfort.rb 2012-09-07 22:47:44 +02:00
jj 64a8443b5a slayrace: add single-creature targetting, add magma column mode 2012-08-03 17:00:06 +02:00
jj 9c0bc3144a magmasource: add documentation 2012-07-12 14:50:59 +02:00
jj 125de95093 document ruby scripts usage in the README 2012-06-29 14:10:07 +02:00
Petr Mrázek 456c637d82 Merge branch 'master' of github.com:peterix/dfhack 2012-06-14 02:16:24 +02:00
Petr Mrázek eaac32c765 Version bump and text updates. 2012-06-14 00:29:01 +02:00
Rumrusher 31b5def131 Update master 2012-06-11 08:31:44 -03:00
Jared Adams f97e2bf410 Make tiletypes more useful
* Add any option to clear paint/filter
 * Add aquifer bit
 * Stop filtering process killing execute early
 * Filter on all bits, not just dig
2012-04-19 17:44:26 -06:00
Petr Mrázek 5583d47b4f Silly copypasta fail
Mixed up tiletype shape and material in readme
2012-04-18 04:18:08 +02:00
Petr Mrázek 6d53ab37e0 Mass fixage
Updated readme.rst
Fixed up some help strings of plugin commands
Moved catsplosion and regrass to normal plugin folder
Fixed tiletypes and liquids not keeping command history properly
2012-04-18 04:12:11 +02:00
Petr Mrázek c46cb37865 Reformat readme.rst to fit in some reasonable limits 2012-04-18 01:40:07 +02:00
Robert Heinrich 6d180d61c4 autopasture: only process domesticated own units to avoid problems with wild animals forgetting their training and going on a rampage 2012-04-16 21:37:48 +02:00
Robert Heinrich 3b68faa1be updated readme.rst 2012-04-16 17:14:02 +02:00
Robert Heinrich e6ed81508d autobutcher: only ignore built cages which are defined as rooms/zoos.
zone: allow mass-assigning of nicknames (to protect a pasture/cage from autobutcher)
2012-04-16 10:15:37 +02:00
Robert Heinrich e58a46b42b zone: fixed filter 'trained' so it now finds war/hunting creatures (who strangely don't have a training level) 2012-04-16 03:31:49 +02:00
Robert Heinrich 6287ee59d8 updated readme.rst 2012-04-16 00:52:25 +02:00
Robert Heinrich 6197c4e739 zone: added keyword 'not' which negates the filter followed by it (e.g. 'not grazer') 2012-04-15 19:49:50 +02:00