Commit Graph

6499 Commits (c113d9b579059e4b492a5942b41a111d88bdd319)
 

Author SHA1 Message Date
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
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
Mason11987 2993edaf73 spacing 2015-10-12 05:21:16 -04:00
Mason11987 755b4fa384 Fixing assume identities since it causes a crash. 2015-10-12 05:15:32 -04:00
lethosor 505b1f0efc assumed_identities -> identities
Fixes #709
2015-10-11 12:03:16 -04:00
lethosor d3d21fa371 gm-editor: Make df.global prefix optional 2015-10-11 11:44:52 -04:00
lethosor 632a809d6f Update xml 2015-10-11 11:39:16 -04:00
lethosor 38be023d5d Fix TiletypeMaterial/tiletype_material comparison 2015-10-10 13:06:14 -04:00
Japa 46f6afada7 Merge branch 'develop' of https://github.com/DFHack/dfhack into develop 2015-10-09 23:35:39 +05:30
Japa 30c14ed914 send stockpile and civzone extents in remotefortressreader.cpp 2015-10-09 23:35:12 +05:30
lethosor 3685ed5156 Fix typo (comfortable)
Closes #708
2015-10-07 16:43:02 -04:00
lethosor 84eb9e6cf8 travis: Increase number of parallel builds 2015-10-03 16:08:13 -04:00
lethosor 220b73e2a8 Merge remote-tracking branch 'lethosor/travis-build' into develop 2015-10-03 16:06:02 -04:00
lethosor c11febf386 Document add-thought 2015-10-03 16:05:37 -04:00
lethosor f4a2188e42 Travis: Build DFHack 2015-10-03 15:58:41 -04:00
lethosor 0337df94de GCC: Specify C++11 when building protobuf
This is necessary to build with GCC 4.6 on Linux (Travis)
2015-10-03 15:40:28 -04:00
lethosor 5580a255f5 Update stonesense 2015-10-03 14:42:52 -04:00
lethosor d71969fef9 Update clsocket 2015-10-03 13:55:16 -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 c2267013b4 plug: List enabled state 2015-10-03 13:42:20 -04:00
lethosor f874fac500 Consolidate licenses of other dependencies 2015-10-03 13:42:03 -04:00
lethosor 45d095cbab Replace translate_socket_error() implementations with DescribeError() 2015-10-03 10:37:48 -04:00
lethosor 3f5c002634 Pass virtual_identity by reference 2015-10-03 09:27:24 -04:00
lethosor d343dfd8a0 Add a function to find viewscreens (or parents) of a given type
This makes it possible for some plugins to detect the game state more
reliably - for example, prospector would previously fail when
embarking if the viewscreen_choose_start_sitest instance had any
children.
2015-10-02 21:50:55 -04:00
lethosor 60bc2619a1 Fix Sphinx error when using Python 2 2015-10-02 21:34:08 -04:00
lethosor 3b8d5a6a95 Suggest --init flag in missing-submodule messages 2015-10-02 16:59:50 -04:00