Commit Graph

6420 Commits (e92d63d248fa7200dd0da9f1b82a0c89700e05f1)
 

Author SHA1 Message Date
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 5352d37967 BUILD_DOCS should be a visible CMake option. 2015-09-25 19:43:40 -04:00
expwnent dfe9ec90f2 Update XML. 2015-09-25 19:43:14 -04:00
expwnent 3b97a897da Update travis. 2015-09-25 19:15:21 -04:00
expwnent 6d035dd323 Whitespace, syntax. 2015-09-25 19:13:22 -04:00
expwnent 558caa24fb More whitespace errors. 2015-09-25 19:08:42 -04:00
expwnent 6d3409da39 Whitespace. 2015-09-25 18:56:47 -04:00
expwnent 9b07ebbf97 Install documentation. 2015-09-25 18:53:46 -04:00
expwnent a188b9d567 Merge branch 'third-party-scripts' into develop 2015-09-25 17:48:25 -04:00
expwnent 8cc0a0bd42 Include all Roses' scripts. 2015-09-25 17:41:25 -04:00
expwnent 3120c95842 Add maxthyme/prefchange. 2015-09-25 17:18:45 -04:00
expwnent b2801eb909 Third party scripts, fix lethosor, add maxthyme. 2015-09-25 17:13:32 -04:00
expwnent 3c36a4cb07 Add more lethosor scripts. 2015-09-25 16:38:15 -04:00
expwnent 5b5dd3aeae Remove Makefile. 2015-09-25 09:24:37 -04:00
expwnent cc752a582e Initial CMake version of Sphinx stuff. 2015-09-24 02:09:23 -04:00
expwnent d2a1a94368 Merge pull request #693 from PeridexisErrant/sphinx-experiments
Use Sphinx for generating documentation.
2015-09-23 23:51:52 -04:00
expwnent 5bcff42800 Add third party scripts. 2015-09-23 23:46:26 -04:00
PeridexisErrant 79263847a6 Get version string for docs from CMakeLists.txt
Because it's better to have a single source.
Someone else will need to integrate the makefiles though.
2015-09-24 13:33:56 +10: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 27cee0525c Change back to default make.bat name
We'll need to hook building docs into the main build process at some
point, but this is good for now.
2015-09-23 14:21:10 +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 bc5f7f329a Add top-level redirect page for the docs
Because otherwise the pretty docs are buried and that doesn't help
anyone.
2015-09-23 10:17:25 +10:00
lethosor 788860efb6 Log more information about version information on startup
May help address #653
2015-09-22 20:01:05 -04: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 336f8ee611 Name index.rst -> README.rst for Github integration 2015-09-22 18:26:56 +10:00
PeridexisErrant a5d1211fea Moved documentation to docs directory 2015-09-22 18:15:07 +10:00
PeridexisErrant 4a8bf96bd3 Standard basic sphinx setup 2015-09-22 17:42:15 +10:00
expwnent 4190ba3259 Fix .gitmodules. 2015-09-21 20:38:31 -04:00
expwnent 0568edb6e3 Attempt to fix gitmodule remote urls manually. 2015-09-21 19:39:01 -04:00
expwnent dc4dc54912 Add third party script submodules. 2015-09-21 19:34:16 -04:00
lethosor 60ed4a1a50 Merge branch 'develop' of https://github.com/dfhack/dfhack into develop 2015-09-21 19:25:58 -04:00
lethosor 62c903b7be search: Fix crash when disabling a stockpile category
Closes #678
2015-09-21 19:25:20 -04:00
expwnent 3a75d9c87f Merge pull request #692 from expwnent/travis
Move to new travis infrastructure.
2015-09-21 19:09:53 -04:00
expwnent 8c4fb7668d Merge remote-tracking branch 'dfhack/develop' into travis 2015-09-21 19:04:31 -04:00
lethosor 690cfb54a1 pr-check-base: Show more information about HTTP errors 2015-09-21 19:02:23 -04:00