Commit Graph

6723 Commits (7bfeb7cb2b874f545c3fc0f82993b4bebf1eacb3)
 

Author SHA1 Message Date
PeridexisErrant 056c1bcb2d Document new scripts 2015-10-28 10:18:44 +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 a37ae8dbd2 Improve travis checks for branch, script docs
The change to pr-check-base avoids failing builds which should pass
because the GH API is limited.  It'll still work almost all of the time,
but no longer fail builds which previously passed and then pushed more
commits.  Closes #694.
2015-10-28 10:07:02 +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
lethosor 1250bb5204 type: Provide more useful information (script paths, plugin names) 2015-10-27 17:34:32 -04:00
lethosor d58c9019be alias migrants-now -> devel/migrants-now 2015-10-27 17:33:51 -04:00
lethosor 74860e2904 Add spawnunit wrapper
See #716
2015-10-26 21:02:38 -04:00
lethosor 7dd091e57a create-unit: add nickname option 2015-10-26 21:02:03 -04:00
DoctorVanGogh 4e0f426bba Fix code formatting 2015-10-26 02:37:44 +01:00
DoctorVanGogh ba53f3c035 Add 'undisturbed' flag to job item checks 2015-10-26 02:19:41 +01:00
PeridexisErrant 4be9e13d74 Fix digfort docs
I'm sure this isn't the only error in the docs.  Hopefully having them
in the scripts will make spotting issues easier.
2015-10-26 11:06:57 +11:00
PeridexisErrant 413a61423a Tweak docs building
Trying to save the warnings to a file only works if the directory
exists.  Also fix digfort docs error.
2015-10-25 10:14:09 +11:00
DoctorVanGogh fb4d16f477 Enable loading of r3 plugins 2015-10-25 00:04:49 +02:00
lethosor daf20c16bd Indicate development builds 2015-10-24 14:52:00 -04: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
lethosor daefb665dd Merge branch 'renderer-module' into develop 2015-10-22 20:02:36 -04:00
lethosor a2007c369a Merge remote-tracking branch 'warmist/patch-5' into develop 2015-10-22 20:02:12 -04:00
lethosor 8de710f1c1 Add Renderer module - safer way to install custom renderers 2015-10-21 17:18:39 -04: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
Warmist 5fbb950bc2 Fix gm-editor to work with df.global structs
It was broken because df.global is not a real struct and does not have ._field at all.
2015-10-19 18:42:15 +03: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 757c05db86 buildingplan-lib: depend on dfhack 2015-10-18 17:46:37 -04:00
lethosor dd32954cce Make buildingplan-lib a static library
This avoids building buildingplan-lib.cpp multiple times
2015-10-18 13:08:48 -04:00
lethosor c44ac8ec6e Improve handling of fatal errors and errors in dfhack.lua
* Several fatal errors that occurred during core initialization didn't
  stop initialization or set 'errorstate' properly, which caused
  update hooks and other code to crash later. This has been fixed and
  should address crashes like the one mentioned in #470.
* Errors when loading dfhack.lua now cause Lua::Open() to fail, which
  triggers a fatal error in Core::Init()
* Failure to initialize the console no longer results in a call to
  fatal() (since it didn't actually stop initialization previously)
2015-10-17 21:18:04 -04:00
lethosor 9ebaa4d695 Update Lua API.rst 2015-10-17 15:45:49 -04:00
lethosor 5387c03ea0 DFHackVersion: Expose whether the built commit is tagged 2015-10-17 15:35:40 -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 96df70fe0b Use TCSADRAIN when disabling raw mode as well 2015-10-14 15:58:27 -04:00
lethosor 36479dbcda travis/all.py: Avoid actually building DFHack 2015-10-13 21:31:37 -04:00
lethosor 7e8200603c Fix whitespace 2015-10-13 21:31:14 -04:00
lethosor b7406e8944 Merge remote-tracking branch 'Mason11987/patch-1' into develop 2015-10-13 21:25:35 -04:00
lethosor 8a3e0a47dc Require MSVC 2010 on Windows 2015-10-13 16:25:38 -04:00
Mason11987 dea78d0627 Put mistakenly removed comments back 2015-10-12 06:02:51 -04:00
Mason11987 db3a1024e1 Fixes to allow open-legends to allow export as well. 2015-10-12 05:59:51 -04:00