Commit Graph

2065 Commits (c52b2c27c8c5b67b5d8c5ebf68bc5c03cd9f2e1e)

Author SHA1 Message Date
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