Commit Graph

2104 Commits (d0752764be3783442b297626ed215d0df89e4a64)

Author SHA1 Message Date
lethosor 2e4f23d49f
Merge remote-tracking branch 'myk002/myk_isplannedbuilding' into develop 2020-11-13 14:09:36 -05:00
lethosor 8cb38ecf5b
Merge remote-tracking branch 'myk002/myk_metalhead_mario' into develop 2020-11-13 14:04:30 -05:00
myk002 efdba8b596
add buildingplan.isPlannedBuilding 2020-11-13 10:18:54 -08:00
myk002 01741ce6c6
update quickfort guide and aliases
- move bit of alias documentation from aliases-common to aliases.txt
- document new behavior for 'c'ustom stockpiles
2020-11-12 23:23:03 -08:00
Myk Taylor 76759184d3
reinforce that meta blueprints can't cross files
they must refer to labels that are within the same .xlsx or .csv file
2020-11-12 23:23:03 -08:00
Myk Taylor 93c8de9b23
use numbered lists in meta blueprints section 2020-11-12 23:23:03 -08:00
Myk Taylor 647093f5c8
quickfort guide: 'c' stockpiles don't make sense
explain why "custom" stockpiles aren't meaningful to create in a
blueprint and what the user should do instead
2020-11-12 23:23:03 -08:00
myk002 54eec5d47f
there is no job-module -- it's just an html anchor 2020-11-12 23:11:55 -08:00
myk002 93d9ac76be
update docs 2020-11-12 23:08:22 -08:00
lethosor a5e58b766b
Update scripts, changelog 2020-11-12 21:07:14 -05:00
lethosor 913d860ae4
Use initial working directory as process path on Linux, and expose to Lua 2020-11-12 19:07:51 -05:00
lethosor 23b230495e
Merge branch 'develop' into cwd-handling 2020-11-12 18:44:05 -05:00
lethosor 9c13b497bf
Merge remote-tracking branch 'myk002/myk_automaterial_buildingplan_fix' into develop 2020-11-11 23:36:42 -05:00
lethosor 0958fdbf4b
Document script paths
Ref #1690
2020-11-10 00:48:27 -05:00
lethosor 58079217d9
Merge remote-tracking branches 'myk002/myk_buildingplan_no_quality' and 'myk002/myk_buildingplan_pause' into develop 2020-11-03 00:09:03 -05:00
lethosor 7f68229d10
Merge remote-tracking branch 'myk002/quickfort_library' into develop
Conflicts:
	docs/changelog.txt
2020-11-02 13:21:11 -05:00
Myk Taylor f053ccf14b update changelog 2020-10-31 03:05:55 -07:00
Myk Taylor 8d1ba5a83a remove changelog line -- this is new functionality 2020-10-31 02:34:06 -07:00
Myk Taylor 5ac1df96db update changelog 2020-10-31 02:30:26 -07:00
lethosor 27e054c9a7
Merge remote-tracking branch 'myk002/quickfort_dreamfort_walkthrough' into develop
Conflicts:
	docs/changelog.txt
2020-10-30 23:53:25 -04:00
Myk Taylor 22ac163d55 improve UX between automaterial and buildingplan
solves the confusing behavior when both automaterial and buildingplan
are enabled for constructions. the two plugins now communicate with each
other over the Lua layer to negotiate consistent behavior.

if neither plugin is enabled, the standard DF UI acts as normal

if automaterial is enabled but buildingplan is not, then automaterial
behavior is unchanged.

if buildingplan is enabled and automaterial is not then behavior is
the same as other buildings with buildingplan (no material selection
screen, screen stays on building placement screen after placement).
this commit fixes a bug, though, where buildingplan would only lay
down a single tile of contruction instead of a solid block when a
block is requested.

if both plugins are enabled but buildingplan is not enabled for the
building type then automaterial is unchanged from previous behavior,
execpt for an additional header showing the separation between
automaterial hotkeys and buildingplan hotkeys.

finally, if both plugins are enabled and buildingplan is enabled for the
building type then buildingplan behavior prevails, but the box select and
hollow designations features of automaterial are still usable and
useful. the 'Auto Mat-select', 'Reselect Type', and "Open Placement"
automaterial hotkeys are hidden in the UI and ignored in the feed. This
is because buildingplan takes over material selection, so 'Auto
Mat-select' doesn't make sense. Buildingplan also already stays on the
placement screen after placement, so 'Reselect Type' is not necessary.
And all buildingplan-placed buildings have relaxed placement
restrictions (e.g. they can be built in mid-air) so 'Open Placement' is
also not necessary. The missing options are replaced with blank lines so
the vertical alignment of all other options stays constant.

we also remove a few extra lua_pop() calls that are made superfluous by
the StackUnwinder.
2020-10-29 11:00:49 -07:00
lethosor d508ad3c4b
Merge remote-tracking branch 'myk002/buildingplan_building_material_filters' into develop
Conflicts:
	docs/changelog.txt
2020-10-28 23:57:55 -04:00
Myk Taylor 5244ca106b attribute dreamfort updates to the quickfort script 2020-10-27 22:03:14 -07:00
Myk Taylor 556c935e2b update changelog 2020-10-27 22:01:27 -07:00
lethosor ccfc1f8a53
Use keyboard formatting 2020-10-28 00:19:26 -04:00
lethosor e61839b571
Fix ordered list 2020-10-28 00:01:51 -04:00
lethosor 64114551dd
Merge remote-tracking branch 'myk002/quickfort_docs' into develop 2020-10-27 23:45:39 -04:00
lethosor 3ab9157a2d
Merge remote-tracking branch 'myk002/buildingplan_refactor5_allbuildings_squashed2' into develop 2020-10-26 21:37:41 -04:00
Myk Taylor 371f68f0a3 update changelog 2020-10-26 16:22:15 -07:00
Myk Taylor a0c86b8a9b rewrite quickfort user guide into
spend more space highlighting how users can use the blueprint plugin to
avoid learning how to write blueprints themselves
2020-10-24 21:14:09 -07:00
Myk Taylor 3e0b0f8078 update changelog 2020-10-24 09:21:18 -07:00
lethosor 4301252ddf
Merge remote-tracking branch 'myk002/buildingplan_refactor2_squashed' into develop 2020-10-23 13:51:54 -04:00
Myk Taylor 233ce26ab5 update changelog 2020-10-23 09:45:41 -07:00
Myk Taylor 7e78d8802e migrate qf's buildings_use_blocks to buildingplan
- remove buildings_use_blocks setting from quickfort config file
- add a new Buildingplan Global Settings dialog to house global settings
- move Quickfort Mode (for legacy Python Quickfort) into that dialog
- add four settings to control how generic building materials are matched:
  - blocks
  - boulders
  - logs
  - bars
- ajust the buildingplan algorithm to register duplicate tasks for
  building material item filters, one for each type. since we track how
  many items we've matched for a filter, the first matched item will
  "win" and the extras will get detected as invalid and popped off the
  queue.
- ensure boulders, logs, and bars are scanned last, and in that order
- more global settings planned for the future! see
  http://www.bay12forums.com/smf/index.php?topic=176889.msg8202679#msg8202679
2020-10-22 21:37:49 -07:00
lethosor 26505acb70
Add some cross-references and clean up 2020-10-20 01:18:25 -04:00
lethosor 2bd0e938ad
Move pathable to Lua API docs 2020-10-20 01:11:01 -04:00
lethosor 84973d1fb8
Sort plugins in Lua API.rst 2020-10-20 01:06:47 -04:00
lethosor 3a200fcd92
Expand `probe` documentation 2020-10-20 01:01:02 -04:00
Myk Taylor 05d2e5b65c update case study: order-dependent aliases
since the example I had used no longer exists now that we have
parameterized aliases. I had to find another example in the industry
blueprints. I made it a proper "tip" and added more explanation as well.
2020-10-18 13:49:11 -07:00
Myk Taylor 6c3bac2d6c document extended zone configuration syntax 2020-10-17 22:20:39 -07:00
Myk Taylor 09fbaba726 buildingplan: support all building types
Allow buildingplan to handle all building types, update the docs, and add in little extra fixes to ensure all the new types work correctly.
2020-10-16 14:23:35 -07:00
Myk Taylor 82013c0c5e prep buildingplan for core algorithm changes
Lots of refactoring and reorganizing, with only cosmetic player-visible changes.

- show quickfort mode hotlkey label regardless of whether the current building type has buildingplan enabled. before, it was only shown after the user enabled buildingplan for the current building. this eliminates the extra step when enabling quickfort mode, which force-enables all building types.
- changed signature of lua-exported isPlannableBuilding to take subtype
  and custom type in addition to building type. this is only used by
  quickfort, and it already sends all three params in preparation for
  this change
- added lua-exported scheduleCycle(), which is like doCycle(), but only
  takes effect on the next non-paused frame. this lets quickfort
  run only one buildingplan cycle regardless of how many #build
  blueprints were run
- declared a few dfhack library methods and params const so buildingplan
  could call them from const methods
- converted buildingplan internal debug logging fn to have a printf api
- reshaped buildingplan-planner API and refactored implementation in
  preparation for upcoming core algorithm changes for supporing all
  building types (no externally-visible functionality changes)
  - changed df::building_type params to type, subtype, custom tuple keys
  - introduced capability to return multiple filters per building type
    (though the current buildings all only have one filter per)
- split monolith hook functions in buildingplan.cpp into one per scope.
  this significantly cleans up the code and preps the hooks to handle
  iterating through multiple item filters.
- got rid of send_key function and replaced with better reporting of
  whether keys have been handled
2020-10-16 13:52:23 -07:00
lethosor ce7772a1c2
Add Filesystem::restorecwd()
This allows restoring the working directory to its original value, which may not actually be the DF root. See #1671, dfhack/scripts#152
2020-10-14 21:22:53 -04:00
Myk Taylor e4b6fb0ff4 Merge branch 'buildingplan_refactor' into buildingplan_refactor2_squashed 2020-10-12 22:39:55 -07:00
lethosor cc159909e2
Mention some third-party Linux packages
Closes #20
2020-10-13 00:24:29 -04:00
lethosor 93520b4b00
dwarfmonitor prefs: fix segfault if item_subtype is null for some item types 2020-10-11 20:45:56 -04:00
Myk Taylor 9d2abafefc Merge branch 'buildingplan_refactor' into buildingplan_refactor2_squashed 2020-10-11 12:11:51 -07:00
lethosor b343d00800
Update to 0.47.04-r3 (authors, changelog, and submodules) 2020-10-10 17:31:30 -04:00
lethosor 9c8098b4f0
Expose to_search_normalized to Lua, add test, and use in ListColumn (most useful for the `stocks` plugin) 2020-10-10 01:40:00 -04:00
lethosor 8d85261cdc
Update changelog (#1658 and more of #1652) 2020-10-09 22:20:07 -04:00
lethosor b972246d16
Update docs (#1652) 2020-10-09 21:43:58 -04:00
lethosor 5e63e6e103
Convert some links to use :wiki: 2020-10-09 19:24:52 -04:00
lethosor 2382247398
Update some docs links to use HTTPS 2020-10-09 19:17:59 -04:00
lethosor 9eff62a05d
Update docs for #1659 2020-10-09 12:38:45 -04:00
lethosor 28efe1d2a7
Add local TOCs to Lua API plugin sections 2020-10-09 12:20:13 -04:00
lethosor f10bc7678e
Allow breaking long inline code snippets if necessary 2020-10-09 12:16:25 -04:00
lethosor c2280356cb
Set language of some code blocks to enable syntax highlighting 2020-10-09 01:15:42 -04:00
lethosor a5f85e256d
Default to a basic DFHack-specific pygments lexer (supporting comments and prompts) 2020-10-09 00:27:22 -04:00
lethosor 2fdd6f7aed
Convert to explicit ref targets (occasionally section links) and fix messages() -> message() 2020-10-08 23:19:16 -04:00
lethosor f54eb9627d
Merge remote-tracking branch 'myk002/quickfort_case_study' into develop 2020-10-08 01:01:37 -04:00
lethosor 6d18ef865d
Merge remote-tracking branch 'myk002/quickfort_docs' into develop 2020-10-08 00:45:27 -04:00
lethosor 600ea23f12
Update scripts and authors 2020-10-08 00:23:01 -04:00
Myk Taylor 3e2dd2a396 quickfort docs: dreamfort case study 2020-10-07 14:01:22 -07:00
Myk Taylor 293bc66f4a update quickfort docs
default dig
notes blueprints
buildingplan
2020-10-06 22:41:54 -07:00
lethosor d254ff2401
Tweak links to quickfort command docs 2020-10-06 22:02:14 -04:00
Myk Taylor a3699a54b8 Merge branch 'buildingplan_refactor' into buildingplan_refactor2_squashed 2020-10-05 22:26:19 -07:00
Myk Taylor 4d7f4d80ad prep buildingplan for core algorithm changes
player-visible changes
- removed text that showed up if you used the wrong hotkeys. no other
  dfhack screen does this, and it seems unneeded. can add back if others
  think otherwise, though

internal changes
- changed signature of lua-exported isPlannableBuilding to take subtype
  and custom type in addition to building type. this is only used by
  quickfort, and it already sends all three params in preparation for
  this change
- added lua-exported scheduleCycle(), which is like doCycle(), but only
  takes effect on the next non-paused frame. this lets quickfort
  run only one buildingplan cycle regardless of how many #build
  blueprints were run
- declared a few dfhack library methods and params const so buildingplan
  could call them from const methods
- converted buildingplan internal debug logging fn to have a printf api
- reshaped buildingplan-planner API and refactored implementation in
  preparation for upcoming core algorithm changes for supporing all
  building types (no externally-visible functionality changes)
  - changed df::building_type params to type, subtype, custom tuple keys
  - introduced capability to return multiple filters per building type
    (though the current buildings all only have one filter per)
- split monolith hook functions in buildingplan.cpp into one per scope.
  this significantly cleans up the code and preps the hooks to handle
  iterating through multiple item filters.
- got rid of send_key function and replaced with better reporting of
  whether keys have been handled
2020-10-04 20:05:08 -07:00
lethosor 2ff4197afe
Add anchor 2020-10-03 23:56:57 -04:00
lethosor 5f47491e78
Use custom link roles when possible 2020-10-02 00:22:35 -04:00
lethosor 90994f2abd
Standardize title 2020-10-01 22:19:33 -04:00
lethosor 00cd52dca7
Add user guides section to main toctree 2020-10-01 22:17:53 -04:00
lethosor 4746e5c046
Change/remove headings to match original TOC nesting 2020-10-01 22:10:11 -04:00
lethosor 77c37ebb73
Switch to native RST table of contents 2020-10-01 22:08:58 -04:00
lethosor 53b78d5266
Convert external docs links to internal links 2020-10-01 21:59:48 -04:00
lethosor 5d98193c54
Convert quickfort user guide to RST using pandoc
Unchanged. First pass of dfhack#1653
2020-10-01 21:50:28 -04:00
lethosor 93d43ba9e3
Update changelog (#1620, #1660) 2020-09-29 20:08:35 -04:00
lethosor 3c037ef52a
Clean up plugin mkmodule/require explanation 2020-09-24 00:16:32 -04:00
Myk Taylor 72fb6d09d6 Merge remote-tracking branch 'upstream/develop' into buildingplan_isenabled 2020-09-23 19:21:16 -07:00
lethosor dfac5bc143
Update gui.Painter docs, add sections to dfhack.screen, add more links, etc 2020-09-23 22:00:39 -04:00
Myk Taylor 12769de232 revert dup isEnabled and document real isEnabled 2020-09-22 23:24:20 -07:00
Myk Taylor b73750e706 Merge remote-tracking branch 'upstream/develop' into buildingplan_isenabled 2020-09-22 22:53:01 -07:00
Myk Taylor c6111ba017 expose if buildingplan is enabled to lua 2020-09-20 16:38:26 -07:00
lethosor 0e6e00af5e
getplants: fix crash when world_object_data is not present for certain blocks 2020-09-20 01:24:46 -04:00
lethosor 9c37a3a068
Add "createitem inspect" subcommand 2020-09-19 20:33:47 -04:00
lethosor 23dc7727b5
Merge remote-tracking branch 'kristjanmoore/develop' into develop 2020-08-29 17:43:46 -04:00
lethosor 100ba998a1
Update changelog, authors (#1633) 2020-08-28 18:44:16 -04:00
kristjanmoore 0fa4987edb Update authors 2020-08-23 18:01:16 +00:00
kristjanmoore cb8a903240 Update changelog 2020-08-23 17:38:27 +00:00
lethosor 8779ca0659
Merge remote-tracking branch 'myk002/quickfort_civzones' into develop 2020-08-21 00:34:26 -04:00
lethosor 7bac4c89c4
Update API docs for setJobCooldown and removeWorker, use "cooldown" for consistency with C++
Ref http://www.bay12forums.com/smf/index.php?topic=164123.msg8180385#msg8180385
2020-08-19 17:12:40 -04:00
lethosor 45a0b7b3a6
Fix stockpiles crash when building food map
Fixes #1628

Broke due to ecd6bcc9ed
2020-08-18 21:00:10 -04:00
lethosor 19a4d1df5a
Merge remote-tracking branch 'myk002/quickfort_buildingplan' into develop 2020-08-17 23:43:05 -04:00
Myk Taylor e4a35514ab document buildingplan Lua API 2020-08-15 23:03:49 -07:00
Myk Taylor e546d3eec3 rename is_civzone to the more general allow_wall 2020-08-15 20:13:48 -07:00
Myk Taylor dd3ff7252d document additional parameter to checkFreeTiles 2020-08-15 17:26:38 -07:00
Myk Taylor 1e9562bd76 add target label for xlsxreader 2020-08-10 23:35:38 -07:00
Myk Taylor 0d9614154f don't turn a rst list into code 2020-08-10 23:04:05 -07:00
Myk Taylor a2279cc9a7 update docs in Lua API.rst too 2020-08-10 14:37:59 -07:00
Myk Taylor 4a04273fae document xlsxreader functions 2020-08-09 09:28:19 -07:00
lethosor f2b0f012c9
Bump to 0.47.04-r2 2020-08-08 14:53:24 -04:00
lethosor 504b0c1ec7
Update changelog (#1596) 2020-08-08 14:47:59 -04:00
lethosor 8f047530c4
Make Units::getRaceNameById and other ID-related functions available to Lua 2020-08-08 14:28:17 -04:00
lethosor 13380008c4
Update scripts, authors, changelog 2020-08-08 13:28:31 -04:00
lethosor 3b3b0be8c5
Update submodules, tweak changelog order 2020-08-08 02:00:12 -04:00
lethosor 6a1f046995
Add --sizecheck option to Linux launcher script, update docs 2020-08-08 00:41:04 -04:00
lethosor f7fda8e7f5
Update changelog, authors, xml (#1615) 2020-08-08 00:06:59 -04:00
Ryan Bennitt 23c22b3b9d Merge branch 'develop' of https://github.com/DFHack/dfhack into feature/manipulator_goal 2020-08-07 22:17:32 +01:00
Ryan Bennitt a85b77e6f1 Retrieve goal string values from enum attributes and add new Units methods to Lua API and docs 2020-08-07 22:07:48 +01:00
lethosor c7e4c724e8
Sort tweaks alphabetically 2020-08-06 22:37:04 -04:00
lethosor 0c53b2b6c5
Add do-job-now tweak
Forum thread: http://www.bay12forums.com/smf/index.php?topic=176700
Original source: https://github.com/dlmarquis/dfhack/blob/dojobnow-r1/plugins/dojobnow.cpp

Co-authored-by: dlmarquis <dlmarquis@users.noreply.github.com>
2020-08-06 22:36:57 -04:00
lethosor bdb9433822
Update/expand Contributing.rst regarding pull requests 2020-08-06 02:30:17 -04:00
lethosor 7c2af344a1
Update changelog (#1564) and xml (dfhack/df-structures#400) 2020-08-06 02:04:23 -04:00
lethosor dba7df7ab8
Add "delete word" support to Console-posix 2020-08-02 23:10:35 -04:00
lethosor 411176c75e
Add rudimentary map docs with tile descriptions from @AtomicChicken
Based on http://www.bay12forums.com/smf/index.php?topic=164123.msg8158676#msg8158676
2020-07-28 00:38:22 -04:00
lethosor c1219642b5
Reorganize dev docs TOC, add label to remote TOC 2020-07-28 00:21:23 -04:00
lethosor 0f0306fc84
Move to internal changelog section + shorten 2020-07-25 15:20:20 -04:00
Myk Taylor 48d4013bcb don't list subdirectories named 'internal'
instead of just specifically for lua files with a '-internal.lua' suffix
2020-07-24 22:07:16 -07:00
Myk Taylor da11932d6b Merge remote-tracking branch 'upstream/develop' into internal_scripts 2020-07-24 20:47:24 -07:00
lethosor fcb14623a7
Update authors, submodules
Ref dfhack/scripts#162
2020-07-24 22:18:00 -04:00
lethosor fddda1818e
Merge remote-tracking branch 'myk002/quickfort_skeleton' into develop 2020-07-24 22:08:24 -04:00
Myk Taylor 86e9f69d42 Merge branch 'quickfort_skeleton' into internal_scripts 2020-07-24 08:24:45 -07:00
Myk Taylor ca1742243b Merge remote-tracking branch 'upstream/develop' into quickfort_skeleton 2020-07-23 22:45:01 -07:00
Myk Taylor e61f2b7451 update Lua API.rst 2020-07-23 22:44:34 -07:00
Myk Taylor e17d492203 address PR review comments on api docs 2020-07-23 21:55:05 -07:00
lethosor 8541db17cd
Remove :width: table directive (requires docutils 0.15) 2020-07-22 02:30:41 -04:00
lethosor 655b363238
Fix some spelling errors 2020-07-22 02:23:29 -04:00
lethosor eb074b8a49
Link to Wireshark script 2020-07-22 02:04:02 -04:00
lethosor 4b6325eeab
Add RPC protocol description to docs and reformat
From https://gist.github.com/BenLubar/1f51cf570b4c8dca275db9687fa6b9e3
Ref dfhack/dfhack#1574
2020-07-22 01:35:32 -04:00
lethosor dfc9f78fa4
Refer to server config docs from dfhack-run 2020-07-21 23:14:59 -04:00
lethosor b34aa86d3c
Document remote server config 2020-07-21 21:41:41 -04:00
Myk Taylor b200219967 support for splitting lua scripts into parts
without polluting the output of #DFHack ls
2020-07-20 23:04:23 -07:00
Myk Taylor 6a851537d5 update changelog 2020-07-19 17:29:56 -07:00
lethosor d88137b1d6
Split remote API info into separate doc, add example tools and clients 2020-07-19 01:13:43 -04:00
lethosor 1e734938ae
Add isoworldremote to Plugins.rst 2020-07-19 01:00:00 -04:00
lethosor 6921277e81
Add upgrading instructions 2020-07-18 12:35:04 -04:00
lethosor 128050c684
Move installation docs to a separate document and expand 2020-07-18 03:16:52 -04:00
lethosor 0cc6f40bd6
Update API docs (#1607) 2020-07-17 17:35:09 -04:00
lethosor 35d659091d
Merge remote-tracking branch 'myk002/blueprint_in_blueprints' into develop 2020-07-17 17:32:59 -04:00
lethosor 56e43a0dde
Linux: make Process::getPath (and dfhack.getDFPath()) not depend on cwd, for consistency with other platforms 2020-07-16 23:21:56 -04:00
lethosor 6cafd230c5
Link to bug from docs (#1585) 2020-07-16 22:42:36 -04:00
lethosor 89c24ac8be
Merge remote-tracking branch 'quietust/reaction-gloves' into develop 2020-07-16 22:40:49 -04:00
Myk Taylor bb91fdcf8c Merge remote-tracking branch 'upstream/develop' into blueprint_in_blueprints 2020-07-16 09:24:52 -07:00
lethosor a0d627ebc7
Merge remote-tracking branch 'PatrikLundell/embark-assistant' into develop 2020-07-16 01:48:07 -04:00
lethosor 470456583c Document PDF build process and add a script for it 2020-07-15 21:42:43 -04:00
lethosor bca76b8fc6 Remove excess/inconsistent padding from lists containing other lists 2020-07-15 21:15:07 -04:00
Myk Taylor e2334387a9 blueprint: write blueprints to blueprints/ subdir
to enable writing to a subdir that may not exist, blueprint now automatically
creates folder trees. E.g. ``blueprint 30 30 1 rooms/dining dig`` will create
the file ``blueprints/rooms/dining-dig.csv``). Previously it would fail if the
``blueprints/rooms/`` directory didn't already exist.
2020-07-15 16:57:14 -07:00
lethosor 9b922c1965 Update scripts, changelog (#1543) 2020-07-15 00:09:47 -04:00
lethosor 1f1bb5a055 Update Lua API docs for ref_target field, add tests 2020-07-14 02:57:30 -04:00
lethosor 89283026ae Improve changelog error handling a bit when called from sphinx 2020-07-13 20:14:11 -04:00
lethosor ced8f4a551 Update changelog (#1565) 2020-07-13 20:05:08 -04:00
lethosor f33f9136c8 Update changelog + authors (#1606) 2020-07-13 19:57:14 -04:00
lethosor a8d34bb64e Add explicit home link to sidebar 2020-07-12 00:30:28 -04:00
lethosor 279d3e80f2 Add kazimuth to authors 2020-07-11 23:56:15 -04:00
lethosor 801961bf78 Move changelog, license, authors into main TOC tree 2020-07-11 23:55:02 -04:00
lethosor 1043a4e49b Update intro, fix bay12 link, shorten index, add quick links section 2020-07-11 23:50:51 -04:00
lethosor 9284daaf89 Unset content min-width to improve mobile layout 2020-07-10 19:59:34 -04:00
lethosor fdb4487a36 Update Linux sphinx installation instructions, define substitution for minumum sphinx version 2020-07-10 02:11:03 -04:00
lethosor ba0f8553ed Misc updates, links 2020-07-08 23:46:38 -04:00
lethosor 7e620b09a4 Update dev-intro
Doxygen was removed in 787c54d8a
2020-07-08 23:38:18 -04:00
lethosor 108e100d22 Move structures overview to Structures-intro.rst and update/elaborate 2020-07-08 23:11:02 -04:00
lethosor 87fd32d330 Move general dev info to a separate doc (Dev-intro) 2020-07-08 22:52:20 -04:00
lethosor 858e90e6c2 Move Scripts-removed.rst to Removed.rst and update a bit 2020-07-08 21:04:23 -04:00
lethosor 24d64175fb Remove top-level links from TOCs 2020-07-08 02:13:37 -04:00
lethosor 85003a40c2 Split memory research into separate doc and expand 2020-07-08 01:03:58 -04:00
lethosor aff2944f28 Add "scripts-" prefix to generated scripts subpage anchors 2020-07-08 01:01:34 -04:00
lethosor 7f56faa64a Tweak Documentation.rst TOC 2020-07-08 00:08:47 -04:00
lethosor 512f425c65 Move Contributing.rst to docs/, add GitHub-specific version in .github/ 2020-07-07 23:49:28 -04:00
lethosor b122870b6a Move documentation standards to Documentation.rst 2020-07-07 01:54:59 -04:00
lethosor b0fe96f6c7 Add gen_changelog.py compatibility shim, fix paths when run under cmake 2020-07-04 02:35:55 -04:00
lethosor f81f77352c Restructure changelog generation as a Sphinx extension 2020-07-04 02:16:11 -04:00
lethosor fa910cd74f Include custom CSS separately instead of overriding theme CSS
May help with https://github.com/DFHack/dfhack/issues/1578#issuecomment-635512324
2020-07-03 22:45:04 -04:00
lethosor 9a3747d307 Make sidebar fixed 2020-07-03 20:42:23 -04:00
lethosor 30c8db811d Add note referring to gui/liquids, update scripts (docs) 2020-07-03 16:51:28 -04:00
lethosor 27ee6a30d4 Add additional path to strawberry perl docs
From http://www.bay12forums.com/smf/index.php?topic=164123.msg8141934#msg8141934
2020-07-01 23:56:41 -04:00
lethosor e39150ac36 Update authors (dfhack/scripts#157) 2020-06-29 23:05:03 -04:00
lethosor ce3cc24228 Split docs on documentation into a separate file and reorganize/expand a bit 2020-06-24 00:12:08 -04:00
Quietust c2776c20b9 Update changelog 2020-06-23 13:37:11 -06:00
lethosor aee4fcd1a6 Add confirmation for convicting dwarves of crimes
Closes #1593
2020-06-20 12:06:50 -04:00
lethosor 861c8c8148 Remove -q from docs/build.sh to make -v work 2020-06-17 20:36:07 -04:00
PatrikLundell dda31c06db merged 2020-06-02 15:08:02 +02:00
Ben Lubar 5d05cfc7cc
Fix several functions in the Units module ignoring unit caste.
Fixes #1583.
2020-06-02 01:18:57 -05:00
lethosor d189b91f49 Update macOS -> OS X, tweak a bit and add more anchors 2020-05-13 22:58:32 -04:00
lethosor 7a9be264c6 Update Linux GCC docs and some ninja notes 2020-05-13 22:46:09 -04:00
lethosor df06f31137 Update forum thread link 2020-05-13 22:25:56 -04:00
lethosor 94d7f3b347 Update docs on cloning and git stuff 2020-05-13 22:25:42 -04:00
PatrikLundell 31d984e934 Fixed 2 incursion handling bugs 2020-05-05 10:21:56 +02:00
lethosor af33f71aa2 Update changelog
Includes #1561/#1566
2020-05-03 22:54:43 -04:00
lethosor 6bdbf5b0dd Update to 0.47.04-r1, update xml, scripts, changelog version 2020-04-25 21:33:02 -04:00
lethosor f76b890cc8 Ensure that dev changelogs are also sorted, since they are pulled in from multiple files now 2020-04-25 21:18:35 -04:00
lethosor 7c1d1c43e5 Merge remote-tracking branch 'PatrikLundell/stocks' into develop
Conflicts:
	docs/changelog.txt
2020-04-25 21:12:27 -04:00
lethosor 3380f9ccf4 Update changelog 2020-04-25 21:03:32 -04:00
lethosor 1546d9ec1a Tweak docs from #1484 2020-04-25 02:41:27 -04:00
lethosor 4dce9f2010 Merge remote-tracking branch 'PatrikLundell/getplants' into develop
Merges #1484

Conflicts:
	docs/changelog.txt
2020-04-25 02:39:05 -04:00
lethosor c6ed0a2458 Update xml, scripts, authors 2020-04-24 21:15:04 -04:00
lethosor b5c6fd26e2 Update changelog (#1531) 2020-04-15 17:33:58 -04:00
lethosor c97adb9173 Update changelog (#1528, #1530) 2020-04-15 01:09:16 -04:00
Nilsolm f7630a5270 update changelog 2020-04-12 11:03:28 +02:00
Nilsolm d734c83a28 also update the changelog 2020-04-11 17:26:09 +02:00
lethosor 0b926e2d15 Update changelog, authors 2020-04-10 23:29:00 -04:00
lethosor f83fee86de Make pairs(df.type) return class methods 2020-04-06 19:12:53 -04:00
lethosor cc2a5acdd3 Update xml, authors 2020-04-05 23:29:53 -04:00
lethosor ad229f2380 Update changelog for #1533 2020-04-04 18:56:44 -04:00
lethosor 42c687de0b Update authors (#1537) 2020-04-04 18:51:49 -04:00
lethosor 5a791ff988 Update scripts + authors
Ref #1540, dfhack/scripts#141
2020-04-04 16:54:29 -04:00
lethosor c8a0ac146c Update submodules, changelog, CMakeLists, Authors 2020-04-04 01:36:52 -04:00
lethosor 6e29672e52 Update notice in changelog, add 0.47.04-beta1 section 2020-04-04 00:36:18 -04:00
lethosor 0c85494a99 Add support for multiple changelog sources 2020-04-03 23:29:10 -04:00
lethosor 77e40a52c0 Update scripts, xml, authors 2020-03-21 02:02:00 -04:00
lethosor d42e866a35 Merge remote-tracking branch 'PatrikLundell/embark_assistant' into develop 2020-03-20 23:22:38 -04:00
lethosor 326dcc8b0f Update scripts, authors 2020-03-20 02:03:31 -04:00
lethosor 58c9fc9bb2 Mention creature/caste flag name changes in changelog
See dfhack/scripts#113
2020-03-20 01:03:28 -04:00
PatrikLundell cd4c7ee422 Updated embark-assistant. Lt aquifer, trees, neighbors 2020-03-03 21:45:20 +01:00
lethosor fb6dd691d7 Update changelog + CMakeLists for 0.47.03-beta1 2020-02-27 19:56:37 -05:00
PatrikLundell 121497a466 Propagated getBookTitle to Lua 2020-01-26 11:47:47 +01:00
PatrikLundell c6bbf39c6c Issue #1262. Added Items::getTitle and used in stocks 2020-01-25 12:43:02 +01:00
PatrikLundell 04550499b6 Updated getplants documentation 2020-01-22 19:41:06 +01:00
PatrikLundell 9d4d0b195a Added switches for farm seeds and plant counts 2020-01-22 17:33:39 +01:00
lethosor 82f082d7cb Fix authors ordering 2020-01-19 00:15:06 -05:00
lethosor 163971ec56 Bump version to 0.44.12-r3 2020-01-19 00:05:43 -05:00
lethosor 63daacd968 Update changelog (dfhack) 2020-01-19 00:04:40 -05:00
lethosor bb9a7e713e Update changelog and authors (scripts, df-structures) 2020-01-18 23:20:29 -05:00
lethosor f070ac246e Fix link text for "disable" command references in docs 2020-01-18 18:51:54 -05:00
lethosor 7554b30727 Call out infiniteSky docs warning 2020-01-18 18:49:54 -05:00
lethosor afd5d0b184 Add autofarm docs 2020-01-18 18:49:15 -05:00
lethosor 513b7e02a6 Add new verbose option to getplants docs
From #1481
2020-01-18 16:38:19 -05:00
lethosor e5a5e39c3a Move getplants issue details to user-facing docs
Ref #1479, #1481
2020-01-18 16:34:29 -05:00
PatrikLundell 7797f9979b
Merge branch 'develop' into getplants 2020-01-15 20:00:49 +01:00
PatrikLundell 15e06640f6 Partial correction of issue 1479 and added verbose flag 2020-01-15 12:40:43 +01:00
lethosor 4feb0aa21f Merge remote-tracking branch 'PatrikLundell/embark-assistant' into develop 2020-01-14 23:41:22 -05:00
lethosor 47fa9e1159 Update authors, submodules 2020-01-13 23:35:31 -05:00
PatrikLundell 07dedfb333 Fixed/improved river tile detection 2019-11-24 21:32:07 +01:00
lethosor 267d52bd17 Merge remote-tracking branch 'PatrikLundell/embark-assistant' into develop
Closes #1456
2019-11-02 22:10:08 -04:00
lethosor a885e3b9be autoclothing: add docs
Ref #1437
2019-11-02 22:00:43 -04:00
lethosor bf4dec6c6a Update scripts, stonesense, authors 2019-11-02 21:13:17 -04:00
lethosor c2e5ae844c tailor: add docs
Ref #1398
2019-11-02 21:07:10 -04:00
lethosor 119450109f Add jimcarreer to authors (#1463) 2019-11-01 23:53:55 -04:00
PatrikLundell 5eceab2794 Added 'fileresult' optional parameter, improved world traversal 2019-09-23 13:13:04 +02:00
lethosor 01ce954c29 changelog: update with scripts changes since 0.44.12-r2 and clean up 2019-08-23 22:17:09 -04:00
lethosor 0b8eba7d23 Merge remote-tracking branch 'PatrikLundell/embark-assistant' into develop
Conflicts:
	docs/changelog.txt
2019-08-22 21:50:54 -04:00
Alan 2344e60101
Merge pull request #1181 from warmist/twbt_experiments
map-render plugin
2019-08-21 09:33:45 -04:00
lethosor e86e20717e Merge remote-tracking branch 'JapaMala/remote_reader' into develop 2019-07-20 19:05:32 -04:00
lethosor aee7b6b24d Note about pthread/cmake <3.8 issue (from ragundo) 2019-07-20 17:11:11 -04:00
lethosor ea37eecfb1 Document and warn about old CMake versions with Ninja
Resolves #1369
2019-07-16 19:33:33 -04:00
PatrikLundell 8248832cbc Added detection and use of incursions into embark tiles 2019-07-12 22:09:03 +02:00
lethosor c125926727 Update submodules and Authors.rst
Ref #1432
Ref dfhack/stonesense#54
Ref dfhack/scripts#93
2019-07-10 19:21:23 -04:00
Alan 52e128a939
Merge pull request #1432 from LordGolias/feature/improve_readme_fedora
Improve readme, dependencies, and gitignore
2019-07-09 12:18:40 -04:00
PatrikLundell fd722332f8 Embark-Assistant Waterfall detection change added 2019-07-01 13:27:39 +02:00
PatrikLundell aee7e2e481 Mentioned Enbark-Assistant Flat detection modification 2019-06-23 18:34:21 +02:00
PatrikLundell 9c3edac499 Added embark-assistant bug fix note 2019-06-20 15:59:08 +02:00
PatrikLundell b1a544b99c Added embark-assistant bug fix note 2019-06-20 15:48:51 +02:00
PatrikLundell a72d25475b Added Enbark-Assistant entry 2019-06-06 21:18:54 +02:00
JapaMala b64fba5822 Update changelog 2019-04-19 09:25:06 -05:00
JapaMala 85879d96d6 Update changelog 2019-04-07 23:34:50 -05:00
JapaMala d0308d93e9 Merge remote-tracking branch 'dfhack/develop' into remote_reader
# Conflicts:
#	docs/changelog.txt
2019-04-07 23:28:36 -05:00
lethosor 3a9fea9c52 Update stonesense 2019-03-28 11:09:46 -04:00
JapaMala d906e7c462 Merge remote-tracking branch 'dfhack/develop' into remote_reader 2019-03-18 22:00:07 -05:00
Golias f127645799 Added command to install dependencies for Fedora (Linux) 2019-02-09 06:36:53 -05:00
lethosor 17d60c5a1f Mention custom profession folder and clean up docs a bit 2019-01-04 10:51:54 -05:00
Lethosor 26934e6185
Fix typo in changelog 2018-12-28 15:22:34 -05:00
JapaMala c01dbc7cd2 Merge remote-tracking branch 'dfhack/master' into remote_reader
# Conflicts:
#	docs/changelog.txt
#	scripts
2018-12-28 00:08:13 -06:00
lethosor 9fe24e1b3f Update changelog and bump version to r2 2018-12-27 19:39:43 -05:00
lethosor f8dd215012 Update scripts and related changelog entries 2018-12-27 17:57:55 -05:00
lethosor e74946f62e Update xml and related changelog entries 2018-12-27 17:37:13 -05:00
lethosor 3e2c898e1a Merge remote-tracking branch 'PatrikLundell/embark-assistant' into develop
Also move changelog entries to misc improvements per #1383
2018-12-27 16:52:30 -05:00
lethosor 5554b0d89f Merge remote-tracking branch 'suokko/runtime_debug_prints' into develop
Missing update to Plugins.rst from web editor
2018-12-27 16:30:47 -05:00
lethosor a2f8742128 Merge remote-tracking branch 'suokko/runtime_debug_prints' into develop
Also fix and reorganize changelog
2018-12-27 16:28:25 -05:00
Lethosor 0ccfc8be35
Fix a few typos in docs and reorganize a bit 2018-12-27 16:21:24 -05:00
JapaMala 84578d7052 Remove both debug dump functions. They aren't needed anymore. 2018-12-26 01:04:31 -06:00
Japa 9d9b6b377b
Update changelog.txt 2018-12-26 00:42:12 -06:00
JapaMala 45985fe5a9 Merge remote-tracking branch 'dfhack/develop' into remote_reader 2018-12-26 00:23:05 -06:00
JapaMala 09e7fd62bb Updated changelog. 2018-12-26 00:22:25 -06:00
lethosor dfbb2416d9 Update docs for nestboxes (#1395) 2018-12-20 21:29:48 -05:00
Warmist b43ecf5fb1
Update Lua API.rst
Remove trailing whitespace
2018-12-06 15:20:33 +02:00
PatrikLundell 32aaa37070 Added coal search to embark-assistant 2018-12-04 14:54:28 +01:00
lethosor b913076451 Update xml, stonesense, changelog
Merged DFHack/df-structures#296 and (modified) attached changelog
entry
2018-11-24 17:09:24 -05:00
Lethosor 34b8a41ad9
Merge pull request #1403 from BenLubar/imgbot
[ImgBot] optimizes images
2018-11-14 16:43:36 -05:00
Warmist 96d11d1f54 Add to docs 2018-10-12 13:48:53 +03:00
ImgBotApp 0809de2d56
[ImgBot] optimizes images
*Total -- 141.35kb -> 100.12kb (29.17%)

/reversing/doc/building-facing/screw/4.png -- 2.68kb -> 1.46kb (45.67%)
/reversing/doc/building-facing/screw/2-windows.png -- 4.59kb -> 2.54kb (44.59%)
/docs/images/hotkeys.png -- 56.84kb -> 31.62kb (44.38%)
/reversing/doc/building-facing/screw/3.png -- 2.62kb -> 1.48kb (43.58%)
/reversing/doc/building-facing/screw/2.png -- 2.68kb -> 1.53kb (43.18%)
/reversing/doc/building-facing/screw/1.png -- 2.66kb -> 1.56kb (41.58%)
/reversing/doc/building-facing/horizontal_axle/1.png -- 2.74kb -> 1.62kb (40.83%)
/reversing/doc/building-facing/horizontal_axle/2.png -- 2.78kb -> 1.66kb (40.32%)
/reversing/doc/building-facing/waterwheel/linux.png -- 3.94kb -> 2.76kb (29.89%)
/reversing/doc/building-facing/horizontal_axle/2-windows.png -- 14.74kb -> 12.88kb (12.63%)
/reversing/doc/building-facing/bridge/linux1.png -- 13.42kb -> 11.85kb (11.7%)
/reversing/doc/building-facing/bridge/windows.png -- 15.11kb -> 13.71kb (9.32%)
/reversing/doc/building-facing/waterwheel/windows.png -- 16.52kb -> 15.46kb (6.45%)
2018-08-30 06:18:07 +00:00
PatrikLundell 8663792041 Made cancel state sensitive 2018-08-18 18:01:30 +02:00
PatrikLundell 143b557ad9 Added embark-assistant world match indication 2018-08-05 17:10:41 +02:00
lethosor f2cbd20126 Update changelog for labormanager changes
Ref #1142, #1162, #1379, #1380, #1382
2018-08-04 00:58:27 -04:00
lethosor 1c137f9a35 Fix a few Lua 5.3-related errors
Reported on bay12:
http://www.bay12forums.com/smf/index.php?topic=164123.msg7821831#msg7821831
2018-08-02 14:36:15 -04:00
lethosor d9fb364b3f Fix prospector out-of-bounds crash and improve checking
Fixes #1370
2018-07-21 00:27:11 -04:00
lethosor c53353fc28 Update changelog, xml 2018-07-20 23:29:24 -04:00
lethosor 8bfa96f701 Update docs for #1365 2018-07-20 23:16:50 -04:00
lethosor 09ec8910ca Avoid clearing CMAKE_CXX_FLAGS for plugins 2018-07-19 15:32:08 -04:00
lethosor af53fe6740 embark-assistant: fix x=16, y=16 dimensions 2018-07-19 14:48:28 -04:00
lethosor 163c9b4059 Add utils.OrderedTable, make test order consistent
Also added OrderedTable tests and comment support to expect.*()
2018-07-19 12:40:25 -04:00
lethosor 4070b5235e Merge branch 'docs' into develop 2018-07-17 11:11:31 -04:00
lethosor 55d5d47776 Fix architecture note in compile docs 2018-07-17 11:10:46 -04:00
lethosor 3b44c18576 Followups for #1325
- Fix git tag detection
- Fix changelog entry position
- Update/clean up docs some
2018-07-17 00:58:49 -04:00
lethosor 1d6c3dc871 Merge remote-tracking branch 'suokko/fix_cmake_dependencies_to_generated_headers' into develop 2018-07-17 00:24:18 -04:00
lethosor 44b7e8df71 Update docs for #1351 2018-07-14 21:09:36 -04:00
lethosor c2a64b3573 Update changelog, xml, bump to r1 2018-07-13 21:16:35 -04:00
lethosor 210510591b Merge remote-tracking branch 'PatrikLundell/embark-assistant' into develop 2018-07-13 19:58:27 -04:00
Pauli cb77c91049 Update Compile.rst to prefer ninja 2018-07-13 18:38:58 +03:00
Lethosor 3e47de5b45
Merge branch 'develop' into embark-assistant 2018-07-13 11:33:57 -04:00
PatrikLundell cfc9b759e0 Removed embark-assistant screen size restriction 2018-07-13 17:20:55 +02:00
PatrikLundell c2dc429b7f embark-assistant changes noted 2018-07-13 17:20:16 +02:00
lethosor 14725bce59 Make DFHACK_BUILD_ARCH default to 64 2018-07-13 11:04:33 -04:00
lethosor c259a892c3 Update scripts (modtools/force fix) 2018-07-13 11:02:36 -04:00
Pauli e34f10f3df Changelog entry for the generated header dependencies 2018-07-13 15:15:42 +03:00
lethosor c82532fd4b Merge remote-tracking branch 'suokko/ruby_memory_return_calling_convention' into develop 2018-07-12 14:53:20 -04:00
lethosor 242dabfdb0 Update scripts/rejuvenate.lua 2018-07-12 14:44:29 -04:00
lethosor 61890c5a60 Merge branch 'develop' of gh:dfhack/dfhack into develop 2018-07-12 10:34:23 -04:00
lethosor 7f523f4be2 Mention the need to initialize new submodules after `git pull` too
See #1361
2018-07-12 10:33:04 -04:00
Ben Lubar 2e34a480e5
Update Compile.rst note about Visual Studio. 2018-07-11 20:29:11 -05:00
lethosor 350ead2651 Add digv and related anchors 2018-07-11 12:02:30 -04:00
lethosor 9ee368d456 Merge remote-tracking branch 'suokko/MapCache_reduce_latency_from_designation_to_jobs' into develop 2018-07-11 11:51:24 -04:00
lethosor 7afa3690bf Add support for DFHACK_BUILD_ID
Used for BuildMaster builds, for example
2018-07-11 11:47:55 -04:00
lethosor e1d1182406 Add embark-assistant changes to changelog 2018-07-10 13:04:42 -04:00
lethosor fa8c6724f6 Merge remote-tracking branch 'suokko/dlsym_libgraphics' into develop 2018-07-10 12:25:11 -04:00
lethosor dd3c04eb26 Merge remote-tracking branch 'suokko/windows_crash_after_die' into develop 2018-07-10 11:57:10 -04:00
lethosor dd340ebfe3 Changelog updates for #1338, #1353 2018-07-10 11:38:36 -04:00
Pauli 988a5a7813 Changelog entry for the fix 2018-07-10 18:27:06 +03:00
lethosor 4a842810d5 Update xml, changelog 2018-07-10 11:24:26 -04:00
Pauli 4d7008fbfa Changelog entry for dlsym vtable loading 2018-07-10 17:10:30 +03:00
lethosor 2dac3c53c7 Add stress cutoffs to Units module, fix dwarfmonitor/manipulator
Fixes #1292
2018-07-09 15:59:12 -04:00
lethosor 46e53fc3b3 Make df2console only call df2utf if the output stream is a console
Fixes output in command-prompt, for example
2018-07-09 11:00:28 -04:00
lethosor 7fcc6be6f6 Update xml, changelog 2018-07-09 10:46:19 -04:00
lethosor 6a76631375 Merge remote-tracking branch 'suokko/console_math_error_fix' into develop
Also update changelog
2018-07-09 09:20:38 -04:00
lethosor 5d16e5a74c Bump to 0.44.12-alpha1 2018-07-08 14:26:57 -04:00
lethosor 10abbf8ac2 Update docs for dfhack/stonesense#57 2018-07-08 00:19:58 -04:00
lethosor 046e911f2c Update changelog.txt (#1312, dfhack/df-structures#263) 2018-07-07 23:51:39 -04:00
lethosor 00fa70dae9 Bump to beta2.1 (stonesense fix) 2018-07-07 21:42:01 -04:00
lethosor c3b0a30c10 Changelog: move lua/ruby above structures 2018-07-07 21:41:43 -04:00
lethosor 9bc8f4abdf Bump to beta2 2018-07-07 19:45:21 -04:00
lethosor d2d1501dfd Merge remote-tracking branch 'suokko/workflow_crafts_advanced' into develop 2018-07-07 19:43:16 -04:00
lethosor 037e7e4901 Merge remote-tracking branch 'suokko/spotclean_ui_state_fix_1194' into develop
Moved/adjusted changelog entry
2018-07-07 18:08:53 -04:00
lethosor 5a0d00d5d2 Bump to beta1, update scripts, update/fix changelog 2018-07-06 17:56:22 -04:00
lethosor c006df561e Merge remote-tracking branch 'suokko/lua_printall_recurse' into develop 2018-07-06 14:25:35 -04:00
lethosor be9affc8fb Update xml, changelog 2018-07-06 14:22:46 -04:00
lethosor f1684125ee Add #1342 to changelog 2018-07-06 11:07:46 -04:00
lethosor 54cf8b7dc3 Fix getVisibleName for units with identities
As of 0.44.11 (possibly 0.44.01), identity names take precedence over the
associated histfig names. Tested with:

https://drive.google.com/file/d/1bX5CQMqNsb_mjJOEOS4wBm4mGDLLs_cZ/view (#1279)
http://dffd.bay12games.com/file.php?id=13428 (from http://www.bay12games.com/dwarves/mantisbt/view.php?id=10530)

Fixes #1279
2018-07-06 11:06:04 -04:00
Pauli 57dd9e944e Fix crafts advanced constraints in workflow
Fixes #1247
2018-07-04 19:10:51 +03:00
Pauli c201cf5b7b Documentation and Changelog for debug printing and Signal 2018-07-04 15:43:15 +03:00
lethosor ae5a1fad84 Changelog entry for Screen::zoom (#1332) 2018-07-03 00:32:15 -04:00
lethosor dc444add10 Fix changelog section for #1318, update scripts 2018-07-03 00:28:29 -04:00
lethosor c449041c11 Merge remote-tracking branch 'suokko/lua_List_setChoices_internal_table_1171' into develop 2018-07-03 00:27:22 -04:00
lethosor c5b3fbf673 Add ruby codefactor fix to changelog, hide double viewscreen_civlistst entry 2018-07-03 00:23:59 -04:00
lethosor 2dd8aea5ab Update changelog, scripts 2018-07-03 00:18:23 -04:00
lethosor a4384a9e98 Core.rst: add dfhack-run anchor, use more sensible example 2018-07-03 00:02:53 -04:00
Pauli 03f8a04a43 Document and changelog entry for printall_recurse 2018-06-30 22:40:03 +03:00
lethosor 105ddd86d8 Merge remote-tracking branch 'suokko/jsoncpp_upgrade_to_submodule' into develop 2018-06-29 22:33:00 -04:00
lethosor f8250bd8a4 Merge remote-tracking branch 'suokko/missing_isDiplomat_1324' into develop 2018-06-29 22:19:12 -04:00
Lethosor 5d1141e1ec
Add isDiplomat to API section too 2018-06-29 09:26:16 -04:00
Pauli c39a882b57 Add missing Unit::isDiplomat
Fixes #1324
2018-06-29 16:19:18 +03:00
lethosor aad4bbe65c Authors.rst: fix order 2018-06-28 14:26:32 -04:00
lethosor 3c2bfb6f47 Bump to 0.44.11-alpha1, update changelog, xml 2018-06-28 13:31:56 -04:00
lethosor f9dfb5907b Update submodules, authors 2018-06-27 13:57:34 -04:00
lethosor bc08ba6a3b Update changelog for r2 2018-06-21 22:33:21 -04:00
lethosor 9c7bd562d4 fix-unit-occupancy, autogems: stop running while embarking
Related to #1286 fix
2018-06-21 16:16:54 -04:00
lethosor f20dae5a4c Merge remote-tracking branch 'suokko/fix_dramp_to_check_jobs_1228' into develop 2018-06-21 15:20:41 -04:00
lethosor 854f467f56 Merge remote-tracking branch 'suokko/check_jobs_on_mapcache_commit_1229' into develop 2018-06-21 15:03:51 -04:00
lethosor 7a5e7c7c86 Rename unit_flags1.dead to killed, update submodules/changelog
Follow-up for dfhack/df-structures#247
2018-06-21 11:17:09 -04:00
lethosor 46b6bfd3f7 Merge remote-tracking branch 'suokko/fix_stocks_to_filter_military_items_1288' into develop 2018-06-21 00:04:06 -04:00
Pauli 37e3a59b7c Changelog entry for command-prompt screen hiding 2018-06-20 21:51:45 +03:00
lethosor cdca28ddfa Merge branch 'develop' of gh:dfhack/dfhack into develop 2018-06-20 12:10:52 -04:00
lethosor 706f3f9f4c Add missing changelog entries from #1253 2018-06-20 11:50:26 -04:00
lethosor 79860a61ad Update changelog (#1300, #1302) 2018-06-20 11:29:21 -04:00
lethosor 5bfe4fd72b Mention Lua API-only plugins in Plugins.rst 2018-06-20 11:22:21 -04:00
lethosor 7f9270407f Update other docs for cxxrandom/#1204 2018-06-20 11:17:05 -04:00
lethosor 26427c2e43 Document cxxrandom in Lua API.rst (#1204) 2018-06-20 11:13:40 -04:00
lethosor b9df6fae85 Update xml, authors 2018-06-20 10:51:24 -04:00
Pauli 40469c6bef Changelog entry for List:setChoices change 2018-06-20 17:38:34 +03:00
Pauli a38aefbe44 Changelog entry for deramp fix 2018-06-20 15:54:31 +03:00
Pauli 41f48bca7a Changelog entry for item in stocpile check 2018-06-19 18:07:44 +03:00
Lethosor f9de49283c
Merge branch 'develop' into check_jobs_on_mapcache_commit_1229 2018-06-18 21:50:14 -04:00
Pauli 7c94620282 Add changelog entry for designation fix 2018-06-18 16:42:29 +03:00
Pauli bb577c070f stockpiles load unusable and usable changelog entry 2018-06-14 22:27:13 +03:00
Pauli 540a4a18ac Changelog entry for jsoncpp update 2018-06-14 21:22:37 +03:00
lethosor ca744139f0 Update changelog (#1309) 2018-06-14 14:14:41 -04:00
lethosor 93a197b3d4 Update changelog for #1297, #1307 2018-06-14 10:38:01 -04:00
lethosor 808e795960 Document new Units API functions from #1297 2018-06-14 10:37:31 -04:00
lethosor ee3a726c29 Update changelog (#1306) 2018-06-13 16:15:57 -04:00
lethosor 3167678dfc Add #1299 to changelog 2018-06-13 16:04:47 -04:00
lethosor de0521e618 title-version: add to options screen 2018-06-12 16:38:53 -04:00
lethosor 40d0d946a4 autogems: avoid crash with non-workshop links, add some logging
Also update changelog, including revflood change

Fixes #1303
2018-06-12 12:17:04 -04:00
lethosor 69cf5756c3 Update changelog (#1284, #1274) 2018-06-08 22:27:48 -04:00
lethosor c4692b1c8d Merge remote-tracking branch 'TotallyGatsby/buildingplanmax' into develop 2018-06-08 22:07:54 -04:00
lethosor 82aaba5c34 Update changelog (#1281) 2018-06-08 22:06:20 -04:00
lethosor 753ce6479e Add suokko to Authors.rst
Ref #1296
2018-06-08 22:01:52 -04:00
Pauli 86b0fb3b92 Add lua profiler module documentation 2018-06-06 19:19:10 +03:00
lethosor 02b7f2145f Update changelog
Ref #1280, #1282, #1283
2018-06-01 00:23:58 -04:00
lethosor 0dba4d3f58 Add caravan to changelog 2018-05-31 12:38:35 -04:00
lethosor 11a2036721 Update scripts and corresponding changelog entries 2018-05-29 23:29:16 -04:00
lethosor f57327e7c8 Fix periodic events in several plugins
Also stop running buildingplan/fortplan while loading a world, and stop running
autogems while paused

Fixes #1286
2018-05-29 23:24:02 -04:00
lethosor cf4b790608 Update changelog (#1108, #1289) 2018-05-29 22:18:57 -04:00
Phillip Spiess 385ac3f9f5 Add 'Max Quality' setting to buildingplan 2018-05-20 14:36:50 -07:00
lethosor 0f3244336b Fix "gen_changelog.py -a" with empty future section 2018-05-18 14:52:25 -04:00
lethosor 6047ddedd3 removed structure updates from wrong changelog (not part of 0.44.10-beta1) 2018-05-18 14:35:28 -04:00
lethosor badc0e3a3d Update changelog, submodules for r1 2018-05-18 14:30:09 -04:00
lethosor 8c8585d4ee Update changelog/authors (#1278) 2018-05-18 00:50:23 -04:00
lethosor b551e70ffa prospector: Avoid crashing due to invalid vein materials
Fixes #1276, ref #1277
2018-05-17 19:56:48 -04:00
lethosor 759ba5c420 New tweak: kitchen-prefs-all
Options to toggle brew/cook for all listed items

Also fixed kitchen lua docs and moved kitchen search option
2018-05-17 19:47:56 -04:00
lethosor d502dce2db Add TOC to "C++ function wrappers" section 2018-05-17 19:36:02 -04:00
lethosor 17ba492992 Add some exclusion functions to Kitchen module, expose to Lua, fix build 2018-05-17 19:34:03 -04:00
lethosor 79a0794658 Add kitchen preferences search 2018-05-17 00:11:52 -04:00
lethosor 3c5a9457b4 Add some suggested keybindings from docs to dfhack.init-example
Ref #988
2018-05-16 19:45:47 -04:00
lethosor c85274eb01 tweak max-wheelbarrow: fix conflict with building renaming
Reported by xordae on bay12:
http://www.bay12forums.com/smf/index.php?topic=164123.msg7762438#msg7762438
2018-05-16 16:51:45 -04:00
lethosor 0be16d4422 New tweak: stone-status-all
Adds an option to toggle the economic status of all stones

Also suggested by xq on IRC
2018-05-14 22:54:20 -04:00
lethosor 914b376082 Add stone status search
Suggested by xq on IRC
2018-05-14 22:30:21 -04:00
lethosor 521da26c40 Document all dfhack.gui functions 2018-05-14 21:35:32 -04:00
lethosor e9ec08f419 Add Buildings::getRoomDescription(), moved from search plugin, +cleanup 2018-05-12 17:00:21 -04:00
lethosor c15571caa0 Move isRouteVehicle, isSquadEquipment from workflow to Items module 2018-05-12 14:49:30 -04:00
lethosor a34b34d3cb Move a few item functions from autotrade/stocks into DFHack::Items 2018-05-12 12:04:46 -04:00
lethosor a0ea756789 Add logo to docs 2018-05-12 11:02:34 -04:00
lethosor 5742e1868a Update many things for 0.44.10-beta1
Including authors update for #1265
2018-05-12 00:07:45 -04:00
Lethosor fbe652d7a0
Merge pull request #1265 from db48x/allow-calling-blueprint-from-lua
this allows the blueprint plugin to be called from lua
2018-05-11 23:52:16 -04:00
lethosor 55181bb81c Add Bumber to authors
dfhack/scripts#54
2018-05-11 18:50:44 -04:00
lethosor 1bb90f6436 Update required libs for Linux in Compile.rst 2018-05-09 22:47:42 -04:00
Daniel Brooks b127522992 Merge branch 'develop' into allow-calling-blueprint-from-lua 2018-05-09 12:55:17 -07:00
lethosor cd717a4fe8 Fix stockpiles header in Plugins.rst 2018-05-09 10:39:14 -04:00
lethosor b95e8f433a Update changelog, scripts 2018-05-09 10:37:03 -04:00
Daniel Brooks 1eac476db7 add a note to the docs 2018-05-08 16:04:35 -07:00
lethosor 4fe55639be Update version/submodules to 0.44.10-alpha1 2018-05-07 00:25:21 -04:00
lethosor 32d83be84a Add some recent stuff to changelog.txt 2018-05-05 16:36:16 -04:00
lethosor c9d7f433a9 Update docs for autogems UI 2018-05-05 15:39:16 -04:00
lethosor 3b2112a56e Update scripts/exterminate 2018-04-19 12:14:08 -04:00
lethosor 165167defe Update scripts 2018-04-07 10:47:25 -04:00
lethosor 5ee73a5a73 Add an option to generate changelogs for individual versions 2018-04-05 11:55:25 -04:00
lethosor cb463c34d8 Automatically replace search with search-plugin in changelog 2018-04-05 11:21:45 -04:00
lethosor ef7dc06221 Fix search plugin link and block links to search page in changelog 2018-04-05 11:02:17 -04:00
lethosor 1badadf535 search: fix 4/6 keys in unit screen 2018-04-05 10:08:07 -04:00
lethosor 868c032578 liquids: initialize range dimensions 2018-04-05 02:19:04 -04:00
lethosor 86e0cb4b32 Update changelog (OS X GCC, bump version) 2018-04-04 20:07:41 -04:00
lethosor ad6a96f2c5 Update Compile.rst for GCC 7 (OS X) 2018-04-04 20:01:52 -04:00
lethosor 0ee4010701 Update Authors.rst (#1251) 2018-04-04 17:15:08 -04:00
lethosor 8f3701752d Update xml 2018-04-04 11:36:24 -04:00
lethosor 3e3571094d Update xml (name attrs) 2018-04-03 16:44:30 -04:00
lethosor 490946cc5e Strip markers from multi-line changelog entries 2018-04-03 11:36:11 -04:00
lethosor f6a222751b Update xml (osx64 renderer) 2018-04-03 11:36:06 -04:00
lethosor d6be5549af Update scripts (dfhack/scripts#50) 2018-04-03 11:31:14 -04:00
lethosor 02768cd019 Update future section 2018-04-02 22:30:54 -04:00
lethosor 374243d697 Document changelog process 2018-04-02 22:22:20 -04:00
lethosor ffb62d0e73 Add remaining 0.44 changelog entries 2018-04-02 21:36:41 -04:00
lethosor f8f67b1e23 gen_changelog: remove double colons, add --check flag 2018-04-02 21:36:18 -04:00
lethosor c993417489 Migrate 0.43 and earlier changelogs to History.rst 2018-04-02 20:55:08 -04:00
lethosor 4158267edc Ensure that docs/_auto/ exists 2018-04-02 14:14:03 -04:00
lethosor 476483adb3 Add a script to automatically generate both changelogs from a single file
This avoids the need to manually copy entries between NEWS.rst and NEWS-dev.rst,
and also helps fix some inconsistencies automatically.

Pre-0.44.07 changelogs have not been converted yet.
2018-04-02 13:43:32 -04:00
lethosor 573fcb4bd0 Bump to 0.44.09-alpha1, update news/submodules 2018-04-02 01:00:20 -04:00
lethosor 2c9c935c0e Update submodules/news, bump to 0.44.08-alpha1 2018-03-29 11:38:55 -04:00
lethosor 93bef3351e Update submodules/news, bump to beta1 2018-03-28 22:01:27 -04:00
lethosor 81e3ee7722 Document "fillneeds -all" in changelogs 2018-03-14 14:37:13 -04:00
lethosor 6f864f97b3 Update news, xml 2018-03-14 10:11:45 -04:00
lethosor 40d3b9b782 embark-assistant: fix copy-paste error, update docs (#1231) 2018-03-14 09:28:24 -04:00
lethosor 36f4954182 Update Stonesense and build docs (fixed Allegro download) 2018-02-16 02:16:06 -05:00
lethosor 6260062d05 Add basic embark-assistant docs (closes #1226) 2018-02-11 03:08:02 -05:00
lethosor 269d575267 Document environment variables 2018-02-11 03:07:25 -05:00
lethosor 9fe9e64f09 Add dtimm to Authors.rst (#1180) 2018-02-10 03:04:40 -05:00
lethosor e88ba60ba5 Document "dig" priority arguments 2018-02-03 18:08:15 -05:00
lethosor 2202c781f7 Add a dfhack.script_help() function to assist scripts 2018-01-25 10:55:00 -05:00
lethosor 771b88c6c4 Update scripts, authors, dfhack.init-example for dfhack/scripts#43 2018-01-21 17:44:31 -05:00
lethosor f2890620d1 Remove tweak kitchen-keys - DF bug 614 was fixed 2018-01-18 01:05:33 -05:00
lethosor 167fcd7578 Add gui/liquids changes to changelog 2018-01-15 00:11:03 -05:00
lethosor ce1644d655 Bump to 0.44.05-alpha1 and update submodules 2018-01-14 18:21:46 -05:00
lethosor e1bf878059 Add some missing changelog entries 2018-01-13 16:50:53 -05:00
lethosor 14466d2dfc Update NEWS-dev 2018-01-12 00:29:35 -05:00
lethosor 04523f9e5d dfhack/df-structures#231: twbt_render_map offset for x64 2017-12-29 23:40:55 -05:00
lethosor 3f45ba4e5d Update changelogs 2017-12-29 23:36:43 -05:00
lethosor 8123736de7 Update Authors (dfhack/scripts#27) 2017-12-26 20:36:27 -05:00
lethosor 11c6042416 Update NEWS-dev 2017-12-25 23:01:42 -05:00
lethosor 86dc58f22e Update changelogs 2017-12-23 22:08:04 -05:00
lethosor c10f7ee77a Authors: add @ZechyW (dfhack/scripts#40) 2017-12-23 21:44:18 -05:00
lethosor 98e1842427 List removed scripts to silence docs-related build failure 2017-12-23 21:15:16 -05:00
lethosor 9cc392e457 Authors.rst: Add Kromtec (dfhack/scripts#36) 2017-12-20 23:44:11 -05:00
lethosor f59a91a0db Add more warnings about Lua's delete()
Closes #1170
2017-12-16 16:17:11 -05:00
lethosor ad2c939fea Update Authors.rst: dfhack/scripts#33 2017-12-08 01:19:36 -05:00
lethosor 7721a142d8 Add a basic Lua console API 2017-12-07 14:43:27 -05:00
lethosor fc952bc67f Update NEWS-dev.rst 2017-12-07 14:36:54 -05:00
lethosor 1b706bc162 Add anchor for luasocket 2017-11-23 16:34:22 -05:00
lethosor c546e5e52c Update Authors.rst (dfhack/scripts#31) 2017-11-23 16:06:19 -05:00
lethosor a3288b4b05 Update Authors.rst (dfhack/scripts#32) 2017-11-23 15:54:45 -05:00
lethosor 2473476f98 Update Authors.rst (#1156) 2017-11-23 15:54:34 -05:00
lethosor e20ddb7f1d Update NEWS, document orders 2017-07-12 19:00:24 -04:00
lethosor 2d07e5edea Add new "pathable" plugin 2017-07-05 23:54:55 -04:00
lethosor d6c4aa823a Update scripts, Authors.rst 2017-07-01 19:30:44 -04:00
lethosor 6100074ba6 Add a few MD5 and thread functions to the Lua API 2017-07-01 17:39:17 -04:00
lethosor cc0220f030 Add a "key" option to EditField and FilteredList 2017-06-27 21:10:14 -04:00
lethosor fe8be90992 Add "tweak burrow-name-cancel" to fix bug 1518
http://www.bay12games.com/dwarves/mantisbt/view.php?id=1518

Closes #526
2017-06-25 16:42:30 -04:00
lethosor 10e13c532a Add "tweak cage-butcher" and some extra Building module functions
* Buildings::markedForRemoval()
* Buildings::getCageOccupants()

Closes #906
2017-06-25 15:27:21 -04:00
lethosor 789fc6dde0 Documentation tweaks
- Improve link in Binpatches.rst
- Fix `alias` anchor in Core.rst (ref #701)
- Increase depth of Plugins.rst table of contents. Some plugins were hard to
  find because they fit in multiple categories.
2017-06-23 12:44:34 -04:00
lethosor 0796fafb2a Add new built-in "alias" command
Closes #701
2017-06-19 00:15:20 -04:00
lethosor be606498d4 Disable automatic hyphenation in docs
This was producing undesirable results, such as hyphenating every line in some
paragraphs, in the middle of short words like "repeat", etc.
2017-06-17 19:57:36 -04:00
lethosor 27343e3253 Add unit and tile visibility functions 2017-06-10 21:54:08 -04:00
lethosor 9b63c451b1 Expose getUnitsInBox to Lua 2017-06-10 21:03:42 -04:00
lethosor ae1aa49089 Add map parameter to Lua paintTile() and use in Painter
Also updated gui/siege-engine.lua
2017-06-02 12:42:51 -04:00
lethosor d41ff4e836 Implement map parameters for Lua paintString() and fillRect(), update docs 2017-06-01 16:17:59 -04:00
lethosor 98980b82ba Update Authors.rst
dfhack/scripts#18
dfhack/df-structures#186
2017-05-13 21:54:04 -04:00
lethosor a285175dfc Add more missing anchors to Plugins.rst 2017-05-11 21:59:53 -04:00
lethosor b51e1ad2ef Add missing anchors to Plugins.rst 2017-05-10 19:51:11 -04:00
lethosor 60b5786d93 Add some missing people to Authors.rst 2017-05-06 16:51:49 -04:00
lethosor b7b83e5ce1 Fix major errors in autochop docs 2017-05-05 14:46:57 -04:00
lethosor d3c496cc2b Add getSelectedPlant() and related functions
Currently only works with the center tile of multi-tile trees
2017-05-05 14:45:46 -04:00
lethosor 6c616e349c Update news 2017-04-23 17:13:59 -04:00
lethosor 06737644cd new tweak: hotkey-clear 2017-04-19 13:31:25 -04:00
lethosor 93a977bf5c Add @pjf to Authors.rst
Ref #1074
2017-03-30 23:57:55 -04:00
lethosor 78cb4a31b9 New tweak: condition-material (fixes bug 9905)
http://www.bay12games.com/dwarves/mantisbt/view.php?id=9905
2017-03-28 09:50:38 -04:00
lethosor 0cc51f8d69 Add support for downloading files in advance, useful for offline builds
Also document this in Compile.rst - there have been complaints about the fact
that DFHack downloads files at build time not being documented at all.
2017-03-01 21:29:17 -05:00
lethosor b675f0fd3c Move old git note to bottom of compilation docs 2017-03-01 20:44:47 -05:00
lethosor ea693c41c4 Update Windows build instructions for 0.43.05 2017-03-01 20:35:36 -05:00
lethosor 2fdd4d96b6 Add more XML changes to NEWS-dev 2017-02-11 20:24:51 -05:00
lethosor 8b27ed5f1c Update changelog 2017-02-11 17:07:49 -05:00
lethosor b110355b53 Add missing space 2017-02-11 15:09:46 -05:00
lethosor f89678c472 Fix backticks 2017-02-11 15:07:48 -05:00
Japa Illo c68faaae37 Add basic documentation for the generated-creature-renamer plugin. 2017-02-10 15:30:48 +05:30
lethosor e2fc7d3e00 Update OS X compilation instructions
- GCC 4.8+ is now required - remove references to 4.5, XCode 7, etc.
- Homebrew's formula has been renamed to "gcc@4.8". "gcc48" still works as well,
  so applying this change to the master branch isn't urgent.
2017-01-05 18:35:20 -05:00
lethosor d18beb8daf xml: Add some linux64 offsets, fix ui_sidebar_menus alignment
Fixes #1053
Fixes #1054
Fixes #1055
2016-12-29 15:33:09 -05:00
lethosor 408dba9da7 Update NEWS(-dev) and scripts (add fix/tile-occupancy) 2016-12-28 22:12:22 -05:00
lethosor 4c3515cc6b Update NEWS.rst, add NEWS-dev.rst for prerelease changes 2016-12-14 12:59:55 -05:00
lethosor 4b91d3799e Fix misery docs anchor 2016-12-10 18:30:34 -05:00
lethosor e8c8953cbb Re-add and update misery plugin
Closes #1037
Ref #1011
2016-12-10 18:22:32 -05:00
lethosor b723378a62 Add nocico to Authors.rst (f71d195) 2016-11-26 14:06:31 -05:00
lethosor 08840ccabf Add abbradar to Authors.rst (da3c6404f) 2016-11-23 19:20:20 -05:00
lethosor 1e41cdc7f6 Fix labormanager docs 2016-11-16 15:20:22 -05:00
lethosor 2e6c7a90be fix whitespace 2016-10-31 01:58:40 -04:00
Kelly Kinkade 6383ca13bf Finish clipped sentence. (erk.) 2016-10-25 18:10:29 -05:00
Kelly Kinkade 385d34490b Docs for labormanager 2016-10-25 18:02:07 -05:00
lethosor 8ae513042f Fix mismatched backquotes in History.rst 2016-10-24 10:06:55 -04:00
lethosor a2525b92ac Merge remote-tracking branch 'PeridexisErrant/doc-keybinds' into develop 2016-10-23 18:26:42 -04:00
lethosor 314159849b Merge remote-tracking branch 'jlogsdon/docs/manipulator-professions' into develop 2016-10-23 18:24:09 -04:00
PeridexisErrant f170b70fde Expand plugin docs for workNow 2016-10-20 18:33:31 +11:00
PeridexisErrant 951d293050 Add, use, and require auto docs for all keybindings 2016-10-20 18:33:31 +11:00
James Logsdon b3ff481461 Add documentation for manipulator professions 2016-10-19 20:55:14 -04:00
lethosor 55d2f00555 Update NEWS.rst and Plugins.rst 2016-10-15 16:37:21 -04:00
lethosor 5ed9c935c7 Add dseguin and figment to Authors.rst 2016-10-08 17:05:59 -04:00
lethosor d414e60ff0 Mention DFHACK_BUILD_ARCH and other settings in Compile.rst 2016-10-08 16:57:39 -04:00
lethosor 64e3b12f4f Make docs/build.sh a bit more configurable 2016-08-23 15:54:11 -04:00
lethosor 30601dc3fd Update Compile.rst for GCC 4.8 and x64 changes, and general cleanup
Closes #980
2016-08-23 15:52:39 -04:00
lethosor 7097b1f817 Add TC01, Qartar, milochristiansen to Authors.rst 2016-08-23 14:34:33 -04:00
PeridexisErrant 570ac8d719 Add link to createitem wiki page 2016-08-13 15:46:15 +10:00
PeridexisErrant 468cca3f09 Improve docs on use of OS terminal for DFHack cmds 2016-08-13 13:42:12 +10:00
PeridexisErrant bb66ec6aee Add 'Using Commands' to docs, with pull#767 syntax
Plus consequential changes and minor updates to the table of contents.
2016-08-13 12:51:19 +10:00
lethosor 1a79e7456c Add shell script to build docs
Useful for testing docs without changing BUILD_DOCS if it's set to OFF.
2016-08-11 18:43:34 -04:00
lethosor 53a0d73d23 Add new title-folder plugin 2016-08-09 20:09:50 -04:00
lethosor 79377669a1 Merge remote-tracking branch 'NCommander/dwarfvet' into develop 2016-07-29 16:25:53 -04:00
lethosor eef66b0db1 Get rid of OS X path restrictions (see package/linux/dfhack) 2016-07-12 14:54:06 -04:00
lethosor e357d9e40b OSX -> OS X 2016-07-12 14:53:22 -04:00
lethosor af6fed58f0 Add @mlindner to Authors.rst 2016-07-12 14:51:31 -04:00
Matthew Lindner ed96725293 Add protection from spaces in path and add warning in documentation 2016-07-12 14:44:18 -04:00
lethosor cfaba3ec71 Update various references to scripts/ and mention old git issues in Compile.rst 2016-06-29 19:38:15 -04:00
lethosor 261da66660 Update ab9rf's name 2016-06-26 23:39:10 -04:00
PeridexisErrant cfc322fb7f Improve handling of in-script documentation
Closes issue #823.  This allows for clean unification of html docs and
the in-terminal help text for scripts, including handling in core rather
than on a per-script basis (see issue #947).
2016-06-15 18:28:54 +10:00
PeridexisErrant e6d2f4ea2e Move Contributing.rst for Github banner link 2016-06-15 18:28:54 +10:00
lethosor a947586cf0 Add @hayguen to Authors.rst (clsocket) 2016-06-14 20:16:14 -04:00
Michael Casadevall 39c96c474a Fix ordering, news, and indentation
Signed-off-by: Michael Casadevall <mcasadevall@ubuntu.com>
2016-06-14 16:13:26 -04:00
lethosor f908a1d1b6 Replace catsplosion plugin with a script
Closes #938, #722
2016-06-11 21:44:15 -04:00
Michael Casadevall 628c8ee5bf Fix ordering in Authors.rst
Signed-off-by: Michael Casadevall <mcasadevall@ubuntu.com>
2016-06-08 06:10:18 -04:00
Michael Casadevall 0dc62a5c9c Add to NEWS.rst and authors
Signed-off-by: Michael Casadevall <mcasadevall@ubuntu.com>
2016-06-08 04:15:15 -04:00
Michael Casadevall e99187dc86 Add documentation for dwarfvet
Signed-off-by: Michael Casadevall <mcasadevall@ubuntu.com>
2016-06-08 04:15:09 -04:00
lethosor 1832e563b7 Update xml 2016-05-14 19:41:41 -04:00
lethosor 38051a5a48 remove tweak manager-quantity 2016-05-11 17:51:57 -04:00
lethosor c1e44c178f Add on_click/on_rclick handlers to widgets.Label
Closes #919
2016-05-09 21:30:34 -04:00
lethosor 8b8b58faef Update NEWS.rst and Authors.rst 2016-05-09 21:03:12 -04:00
PeridexisErrant acac839371 Replace fixdiplomats, fixmerchants with scripts 2016-04-20 11:12:06 +10:00
PeridexisErrant eb34ff0cd6 Fix typos and missing links in docs 2016-04-15 16:28:41 +10:00
PeridexisErrant 273c22f606 Shorten "ls" help for plugins
I think that's all of them.
2016-04-15 16:28:41 +10:00
PeridexisErrant feff83cedc Require a short help string for "ls"
The linter change will enforce it for scripts.  Plugins always include
the line, and length will have to be checked manually.
2016-04-15 16:28:41 +10:00
lethosor 7fe142ea76 add many missing section anchors to Plugins.rst 2016-04-12 20:09:41 -04:00
PeridexisErrant 4536f3df71 Fix last typos 2016-04-11 09:30:05 +10:00
PeridexisErrant c2b4ee8d64 Ready for Stonesense docs PR 2016-04-11 09:30:05 +10:00
PeridexisErrant c09b4f6b47 Tweak developer docs 2016-04-11 09:30:05 +10:00
PeridexisErrant 4b9696d295 Fix html redirection to the docs
Now redirects from top level to user-default location, and
if you're in the repo there's a new second redirect to the real docs.
2016-04-11 09:30:05 +10:00
PeridexisErrant faec3b0cbc Use local tables of contents in Plugins.rst
Makes it a lot easier to navigate the structure of the file.
2016-04-11 09:30:05 +10:00
PeridexisErrant 7ebd50697e Better formatting, TOCs in Lua API.rst 2016-04-11 09:30:05 +10:00
PeridexisErrant e0310e3050 Seperate HISTORY from NEWS
Because years-old information is not news any more!
2016-04-11 09:30:05 +10:00
PeridexisErrant b8bb8d0c92 Finish formatting, linking NEWS.rst 2016-04-11 09:30:05 +10:00
lethosor d07eb69a5e Update Authors.rst 2016-04-05 12:04:32 -04:00
lethosor b97d33ca28 moveToBuilding improvements
- Don't set in_building by default when use_mode is 0 (consistent with most vanilla DF items)
- make use_mode optional and default to 0 (including in Lua API)

Resolves #885
2016-04-05 11:43:02 -04:00
expwnent 5bb98295b3 Merge pull request #810 from PeridexisErrant/colonies
Colonies as a script, + place feature by Warmist
2016-03-13 08:32:05 -04:00
Warmist bc02e2a844 Add auto-gears mode for building hacks for automatic animation and gear positions. 2016-03-13 13:37:36 +02:00
PeridexisErrant e519313b70 Convert colonies plugin to script, add place feature 2016-02-01 18:12:38 +11:00
lethosor 514ae890be exportlegends-related documentation updates 2016-01-16 11:34:12 -05:00
Eric Wald 53780d8232 New autogems plugin, automatically cutting rough gems. 2016-01-08 23:18:41 -07:00
lethosor d670ee8ab4 New tweak: block-labors
Prevents labors that can't be used from being toggled

Suggested at http://www.bay12forums.com/smf/index.php?topic=121451.msg6719464#msg6719464
2016-01-08 19:27:11 -05:00
lethosor 974b427833 Add stonetoad to Authors.rst 2016-01-08 17:01:22 -05:00
lethosor 2acdede03b New tweak: hide-priority
Adds an option to hide designation priority indicators
2016-01-04 19:29:30 -05:00
PeridexisErrant 81b055ee93 Implement "weather" as a script 2016-01-01 11:35:58 -05:00
lethosor d923633689 Add moversti, TheBloke, txtsd to Authors.rst 2016-01-01 11:34:52 -05:00
Lethosor 47bbdc8025 Merge pull request #778 from moversti/patch-3
Updated Windows compile docs
2016-01-01 11:27:31 -05:00
lethosor d087f4f741 Expose process MD5/PE to Lua (useful in export-dt-ini) 2015-12-27 14:59:18 -05:00
lethosor 05926d9734 New tweak: title-start-rename
Adds a safe rename option to the title screen "Start Playing" menu
2015-12-26 11:47:58 -05:00
moversti 7d9f2d0c08 Updated Windows compile docs
Needing cmake.portable instead of cmake
2015-12-24 00:31:23 +02:00
Lethosor 285d48fb60 Merge pull request #774 from TheBloke/Docs_misc
Compile docs: Misc changes: Linux re building docs/pip; Windows re MSVC requirement and vs VStudio; Windows re command line compile with Bash.
2015-12-21 21:50:22 -05:00
TheBloke ce0322e8fd Word addition 2015-12-22 02:02:12 +00:00
TheBloke 203b6b967d Windows: new section on using Bash to compile on command line under Windows 2015-12-22 01:57:39 +00:00
TheBloke 017afec271 Word order 2015-12-22 01:44:49 +00:00
TheBloke df7edaf37d Windows: clarification on requirement of MSVC vs Visual Studio and basic explanation why 2015-12-22 01:43:38 +00:00
TheBloke 5648adbc2c Linux: Building docs: Some clarification on pip and sphinx-build 2015-12-22 01:39:39 +00:00
lethosor 24ec588245 Merge branch 'develop' of https://github.com/dfhack/dfhack into develop 2015-12-21 20:38:29 -05:00
lethosor 114c217d52 Remove createitem deprecation notice 2015-12-21 20:38:15 -05:00
TheBloke b5e91d78aa Typo 2015-12-20 21:33:02 +00:00
TheBloke 219a6c7a26 Compile docs: Windows: Add direct download link for MSVC 2010 SP1 2015-12-20 21:25:25 +00:00
TheBloke 5b1e2ff01f Windows: soften the recommendation on Chocolatey to a 'preferred', also some improvements on the Chocolatey description re behaviour when software is already installed. And an update to the Manual Dependencies section. 2015-12-19 14:17:39 +00:00
TheBloke 03ec774142 OSX: fixed wording on DF path 2015-12-19 02:39:03 +00:00
TheBloke 7bfeb7cb2b OSX: Removed dupe statement 2015-12-19 02:37:31 +00:00
TheBloke 895d5a534e Fixes to: Linux: gcc-multilib; OSX: 10.11 notes higher/more emphasised; Windows: reason for why SP1 is required (currently unknown, so downgraded to 'we do not support' rather than a specific reason why it won't work. 2015-12-19 01:59:23 +00:00
TheBloke e3b7cace60 Some re-wording in Building The Documentation, including some 80-char width (approx) re-formatting. 2015-12-15 22:04:10 +00:00
TheBloke 9bc8368d29 Further tweak to Enable documentation build re setting CMAke flag: mention GUI, update Windows advice. 2015-12-15 20:30:11 +00:00
TheBloke 6c7e5c9428 A few additions to the Windows section; more formatting changes including command highlighting; misc other tweaks. 2015-12-15 20:21:22 +00:00
TheBloke 196aec4cb4 + again 2015-12-15 18:51:37 +00:00
TheBloke 2ded0e5ea9 Github->GitHub; git->Git (where not a command); one more change to Perlbrew section 2015-12-15 18:50:59 +00:00
TheBloke e1777fcc6b OSX: Simplify the new local Perl section, just mention what perlbrew as it's obvious enough how to use it from the webpage and most people probably won't be interested anyway. 2015-12-15 14:16:51 +00:00
TheBloke 417f9a26aa Minor bullet point fixes in Mac list 2015-12-15 07:06:23 +00:00
TheBloke 1f928a8292 Typo 2015-12-15 06:16:48 +00:00
TheBloke 1afc0afb9c Some further fixes, updates and elaborations. Had to convert the Mac list to bullet rather than numbered, as HTML numbering keeps breaking (resets to 1 in the middle of the list in several places) for reasons I can't figure out. 2015-12-15 06:08:25 +00:00
TheBloke f26982f1e9 And other minor fixes (actually in this commit this time.) 2015-12-15 04:11:39 +00:00
TheBloke 5aae535394 Building documentation section: now with a non-stupid way of doing it! And other minor fixes. 2015-12-15 04:10:00 +00:00
TheBloke 21631b3712 Compile.rst: major updates to Windows and OSX sections; minor to Linux; new section re compiling documentation; many small fixes.
Introduction.rst: fix typo and remove erroneous end version for OSX.
2015-12-15 03:30:08 +00:00
lethosor df61233774 Merge remote-tracking branch 'PeridexisErrant/new-scripts' into develop 2015-11-26 16:13:27 -05:00
lethosor 75f43b9bf6 Add @Enkrod to Authors.rst
Ref #743
2015-11-26 10:54:35 -05:00
Lethosor d18dae45d8 Merge pull request #743 from Enkrod/patch-2
Typo Restrictliquid fixed
2015-11-26 10:52:57 -05:00
lethosor 597ed1510e Update documentation
Ref #741, #744, #747, #748, #749, #756
2015-11-25 20:56:30 -05:00
Eric Wald 14cf2790d2 Falconne deserves credit for a few great plugins. 2015-11-25 17:51:30 -07:00
PeridexisErrant 842b9c5191 Implement feature as a script, add magma option
Functionality is exactly equivalent to the plugin, but with a new option
for players who want to enable magma furnaces without spoilers.
2015-11-17 16:43:56 +09:30
PeridexisErrant 2ba9ef04e3 Replace drybuckets plugin with a script
Also closes #248, by checking job and building flags.
2015-11-17 13:55:43 +09:30
lethosor 9c62ff1d7f Blacklist GCC 5 on Linux again
GCC 5 mangles some symbols, such as "plugin_globals" ->
"plugin_globals[abi:c++11]" (or "_Z14plugin_globalsB5cxx11"), even
when declared with 'extern "C"'. This breaks plugins, in particular.
2015-11-10 18:51:29 -05:00
lethosor 72adb904f6 Document multilib packages 2015-11-10 16:57:38 -05:00
Sebastian Wolfertz e209e3937a Typo Restrictliquid fixed
restrictliquid is actually restrictliquids.

This time with lengthened underline for sphinx.
2015-11-10 07:50:38 +01:00
PeridexisErrant 99b93ecd11 Move index back to root 2015-11-07 19:42:18 -05:00
lethosor 52989ab40a Update Compile.rst 2015-11-07 17:18:50 -05:00
lethosor 6e8936faa7 Link to VS2010
Thanks to @TheBloke

http://stackoverflow.com/questions/3061811
2015-11-07 16:48:00 -05:00
lethosor 1da42c9115 Add automaterial label 2015-11-07 15:55:21 -05:00
lethosor e176c3ea05 Merge remote-tracking branch 'PeridexisErrant/docs-again' into develop 2015-11-07 15:50:11 -05:00
PeridexisErrant 0bb203e7c9 Replace initflags plugin with scripts
Progress towards #722
2015-11-07 23:42:14 +11:00
PeridexisErrant 6dacbe3d9f Add docs for "sort" and "diggingInvaders" plugins
I don't know how these were missed, but I've now checked everything
listed by "plug" but not (previously) a heading in Plugins.rst
2015-11-07 17:05:57 +11:00
PeridexisErrant 3d801d45c6 Flatten plugin documentation
The obvious solution to not knowing how to categories plugins well is to
do so a little less.  This commit does not rearrange them though, since
I thought that counterproductive without a better idea of what to do.

- removed many headings that are not commands
- fixed a few links and added some
- clarified stockpiles plugins
2015-11-07 14:01:18 +11:00
PeridexisErrant 1c25f8f1a3 Unify docs for designation and map-mod plugins
Plus some cleanup and flattening of the behaviour mod plugin docs
2015-11-07 13:04:47 +11:00
PeridexisErrant a1110b36e8 Add shortlink for issues, update links
Also moved search above local table of contents in sidebar, which can
get very long.
2015-11-07 11:35:44 +11:00
PeridexisErrant 3506921447 Add cross-links for similar commands 2015-11-07 10:53:12 +11:00
PeridexisErrant 7f212178ca Move unused docs to plugin source files
This way they can easily be restored when the plugins are reactivated,
but don't confuse users until then.
2015-11-07 10:13:21 +11:00
PeridexisErrant 5826b49d09 Move index.rst to docs directory
Having the docs index in the repo root was a holdover from when it was
the README file.  Now that it's not much use without being built, it's
better to leave the root to README, NEWS, and LICENSE - especially when
one is a html shortcut to the docs index.
2015-11-06 17:09:56 +11:00
PeridexisErrant 193e71793a Fix compile, intro, scripts
- script-syntax.py now exits with 1 instead of silently catching the
error if lua or ruby are missing
- index paths are absolute (from the repo root)
- less strong suggestion for third-party packs
- re-added lua-example and test-perlin doc
- corrected and clarified Compile some more
2015-11-06 16:58:58 +11:00
PeridexisErrant bc91928f8d Explain ":foo" parsing mode in Core notes 2015-11-06 11:58:33 +11:00
Lethosor 2f8f5b071a Merge pull request #730 from PeridexisErrant/add-scripts
Add updated emigration script, gui/family-affairs
2015-11-05 19:55:15 -05:00
PeridexisErrant 18a921baef Further clarify Core; move plugins out; other fixes
- Fix formatting of (c) in license
- Avoid possible issues with script linting
- Move plugin docs out of Core.rst
- Fix some builtin docs, tweak other bits
2015-11-06 11:44:43 +11:00
lethosor 7fc2a226da Add missing backtick 2015-11-05 19:37:51 -05:00
PeridexisErrant 3cc0b34d73 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-06 10:15:21 +11:00
PeridexisErrant 0ba6f73dcd Add Introduction.rst, list builtins in Core.rst
The Introduction is the first page to read, and thus explains what
DFHack is, installation, basic use, and troubleshooting.

This frees up Core.rst for a detailed list of builtin commands (meant to
be complete, but I might have missed some), some other key commands, and
a discussion of init files.  I also put the random notes that don't fit
anywhere at the bottom of this file.
2015-11-06 10:15:21 +11:00
PeridexisErrant 3d9ba57121 Tidy and update Compile.rst
Eg removed workarounds for closed OSX bug, etc.
2015-11-06 10:15:20 +11:00
PeridexisErrant 8aafcec0c8 Add unacknowledged contributors
Mostly authors of scripts which have been added.
2015-11-06 10:15:19 +11:00
PeridexisErrant 45c3f145e5 Add gui/family-affairs 2015-11-05 13:17:26 +11:00
lethosor cbf31dcb37 Merge remote-tracking branch 'PeridexisErrant/NEWS-cleanup' into develop 2015-11-04 19:54:13 -05:00
PeridexisErrant 6df0e26b05 Require 3rdparty docs to be in script source files 2015-11-02 09:32:50 +11:00
lethosor 21ace4249a Add 3rd-party script authors 2015-10-31 16:52:47 -04:00
lethosor 96834923b9 Clean up Authors.rst
* Remove email addresses, following a discussion on IRC (these can be
  found in git logs anyway, and having them publicly-visible invites
  spam)
* Remove a couple duplicate authors
* Add a few aliases
2015-10-31 12:01:52 -04:00
lethosor 6c832fadba Add DoctorVanGogh to Authors.rst
See #715
2015-10-31 11:55:05 -04:00
lethosor 45284fab17 Sort Authors.rst alphabetically
Previous changes combined the list of dfhack and stonesense
contributors, which interfered with the old, somewhat-time-based
order.
2015-10-31 11:51:12 -04:00
PeridexisErrant 9b1d277ef5 Finish updating sphinx-build changes
Completes 5643119.
2015-10-31 15:39:00 +11:00
PeridexisErrant 4257940b22 fix typo in dig docs 2015-10-30 14:47:49 +11:00
PeridexisErrant 5643119c71 Get docs building online
Readthedocs runs the build command in the directory conf.py is found,
and to work correctly that has to be the root directory.
2015-10-29 14:26:37 +11:00
PeridexisErrant a8ab595428 Tweak plugins docs
- Minor updates and clarifying edits
- Better use of markup throughout the document
- linked references to bugs and other things
- moved gui/siege-engine docs to the script
2015-10-29 12:46:31 +11:00
PeridexisErrant aee2655886 Merge branch 'develop' of https://github.com/DFHack/dfhack into NEWS-cleanup 2015-10-28 10:07:13 +11:00
PeridexisErrant 5efea525e0 Split GitHub README from Sphinx index
The root of the documentation tree has a different function to the short
readme we want to display on GitHub, which now links to the main docs
(or Bay12 thread, or IRC).  It also renders properly on GitHub, and can
use live-updating status badges because we don't expect it to work
offline.
2015-10-28 10:06:28 +11:00
PeridexisErrant c113d9b579 Format future news 2015-10-24 22:57:08 +11:00
PeridexisErrant a3803d340e Build docs in place; copy inputs so users can build
Building the docs now works the same way, no matter when it happens - in
a cloned repo or distributed version.

This means all the relative links keep working; and that users or
downstream distributors can rebuild the docs with extra scripts or .rst
files in place.

Finally, it eliminates a large number of potential bugs which only occur
in one build environment and are difficult to reproduce.

Also add headings and this work to future news.
2015-10-24 22:19:52 +11:00
PeridexisErrant 69090e114c 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 17:41:21 +11:00
PeridexisErrant 54f3c6a138 Updated docs linter for scripts
Also made scripts toctree more explicit
2015-10-24 17:00:54 +11:00
PeridexisErrant ddae19ad8b Move base scripts 2015-10-24 15:10:15 +11:00
PeridexisErrant abb882618b Move modtools docs 2015-10-24 10:57:04 +11:00
PeridexisErrant f8d965b8ea Migrate fix, gui script docs; add link shortcuts
Because it's a lot easier to link to bug reports this way.

The migration is mostly just a copy-paste job, but I'm using keybinding
styles where appropriate too.
2015-10-24 01:37:39 +11:00
PeridexisErrant 5e02e00e2c 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-24 00:33:35 +11:00
PeridexisErrant d98ee535a1 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 22:25:04 +11:00
PeridexisErrant 0f65bb0564 CSS fix 2015-10-23 14:22:52 +11:00
PeridexisErrant 6b78109fe2 Fix encoding issue 2015-10-23 13:18:44 +11:00
PeridexisErrant a60e525a5c Add custom styles for keybindings and ingame text
And use them in Plugins.rst.  Styles copied from
PeridexisErrant/DF-Walkthrough, and derived from the wiki.
2015-10-23 12:57:18 +11:00
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 a305c40bb2 Finish formatting old NEWS 2015-10-20 14:08:34 +11:00
PeridexisErrant fb2fdd0e89 Format more of the NEWS file 2015-10-20 13:29:46 +11:00
PeridexisErrant 18d2bc6183 Format 0.40.24-r3 changelog
Including plenty of nice hyperlinks and a formatting which looks a lot
better in HTML (but still decent in raw text, too).
2015-10-19 14:59:35 +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 bd5eb82554 Get autodoc working properly.
With a complete index, only generate needed files, etc.
2015-10-19 13:57:33 +11:00
lethosor 9ebaa4d695 Update Lua API.rst 2015-10-17 15:45:49 -04:00
lethosor d3dbc6225a Implement getViewscreenByType() in lua 2015-10-17 15:11:04 -04:00
PeridexisErrant a091ba4a70 Use .rst format for NEWS directly 2015-10-15 18:43:25 +11:00
lethosor 3685ed5156 Fix typo (comfortable)
Closes #708
2015-10-07 16:43:02 -04:00
lethosor c11febf386 Document add-thought 2015-10-03 16:05:37 -04:00
lethosor 12684f65bd Reorganize Contributing.rst and fix a few typos
This document is shown when creating pull requests and referenced
from a number of other code-related discussions, so putting the
"contributing code" section first probably makes more sense
(particularly with a TOC).
2015-10-03 13:50:52 -04:00
lethosor 60bc2619a1 Fix Sphinx error when using Python 2 2015-10-02 21:34:08 -04:00
orthographic-pedant ce80a42b24 Typo: accross -> across
Closes #707
2015-09-30 16:32:44 -04:00
expwnent c15b01a79a Autogenerate include-all.rst for scripts so that script documentation can be entirely encapsulated in lua files without updating anything else. 2015-09-27 02:45:11 -04:00
expwnent 094aceff9e Sphinx: locate dfhack-icon.ico properly. 2015-09-26 20:49:43 -04:00
lethosor d6821e6d66 Clean up .travis.yml 2015-09-26 20:05:32 -04:00
PeridexisErrant e92d63d248 Final documentation changes
Squashes a couple of commits from the other branch onto the last one
here.
2015-09-26 16:50:02 +10: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 b51e3f88f3 Use DFHack favicon, fix whitespace 2015-09-26 12:28:09 +10:00
PeridexisErrant d57e84fc0f Document all missing plugins, update NEWS
Checked with a throwaway script, and added the missing entries.  NEWS
now has a comment on how to use the file, which is only visible in the
raw text version.  Added the documentation changes to NEWS.
2015-09-26 12:28:08 +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 53d5d3b897 Add listing of 3rdparty scripts, in Scripts doc
This will automatically find any .rst documentation matching the
pattern, and include it.
2015-09-26 12:28:06 +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 0307b0830f Plugins internal links, more formatting 2015-09-26 12:28:04 +10:00
PeridexisErrant a10c777f8f Add basic section on documentation standards
I expect this to expand once we get autodoc up and running.
2015-09-26 12:28:04 +10:00
PeridexisErrant 780a9f3677 Internal links and link targets, formatted tables
* Enabled internal links; a phrase in backticks is linked to the
corresponding link target and turns into the corresponding title.
* Linked all existing references in Scripts.rst
* Created corresponding link targets
* Fixed formatting of some tables of arguments.
2015-09-26 12:28:03 +10:00
expwnent cc752a582e Initial CMake version of Sphinx stuff. 2015-09-24 02:09:23 -04:00
PeridexisErrant ce09c8e099 NEWS markup for titles; changelog entries linkable
Some very light markup is all that's needed.  The underline with ====
makes each version into a linkable title and allows a table of contents
to be generated, while the `::` and blank line denotes that the rest is
a literal block.
I also shortened some very long lines, for readability.
2015-09-23 15:44:00 +10:00
PeridexisErrant 8661f5dc4f Add linter to check scripts are in readme, pass it
We knew a fair few were missing, but this was more than I expected.
2015-09-23 15:25:41 +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 8dc0e1a66e Clean up in dev-oriented docs 2015-09-23 00:06:56 +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 a5d1211fea Moved documentation to docs directory 2015-09-22 18:15:07 +10:00