Commit Graph

87 Commits (fff9072b0736d94d81648856179d953f5c2061f8)

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