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.
- 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
- 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
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.
A simple list of components with the full text each time is not
particularly useful, or required.
The table lists components in alphabetical order (except DFhack, first),
with license and copyright. Component names are hyperlinked to the
source project, which was not the case previously.
Licenses which are required to be included are, but once only - an
improvement over four zlib, 3 BSD and five (!) MIT blocks. This and the
table satisfies the requirements while remaining readable.
Expands coverage of scripts linting, and improves checks for a correct
title. Various fixes to make 'python travis/all.py' work for offline
users; when the TRAVIS envvar is not set it now fails without an error.
Minor cleanup in conf.py
* 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
PeridexisErrant
lethosor
Japa
Lethosor
DoctorVanGogh
Putnam3145