Commit Graph

37 Commits (36de6e6e536a97dabdbae2ab47c99530c51326c1)

Author SHA1 Message Date
myk002 2a3a812b3c
update tag reference in Core.rst 2022-08-13 21:21:48 -07:00
myk002 e8ffa55dfe
use a label instead of a custom role
since I can't seem to figure out how to inject a link to a label via the
role processing code
2022-07-22 15:16:57 -07:00
myk002 6752025848
fix up some index links 2022-07-22 14:38:16 -07:00
myk002 8d99b7e6e1
prepare for plugin doc split 2022-07-10 20:19:09 -07:00
Myk 4ad8e7199a
Support builtin commands in helpdb (#2241)
* support builtin commands in helpdb, implement list API, document api
2022-07-10 20:17:52 -07:00
Myk 28e15162a5
reorganize init scripts into dfhack-config (#2232)
* reorganize init scripts into dfhack-config

allows player init scripts to build on defaults instead of replace them
this also moves the init scripts out of the main df directory

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* escape asterisks in docs

* remove unneeded dfhack.init file creation for test

* write the test init script to the new init dir

* create the init dir before trying to write a file

* rename default init files for clarity

* Update changelog

* Update docs/changelog.txt

Co-authored-by: Alan <lethosor@users.noreply.github.com>

* Try to get buildmaster to work with old branches

* Update changelog

* get keybindings from all init scripts

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix spacing in changelog

* split default loading into its own file

* update docs with new changes

* update help text wording in default init files

* Apply suggestions from code review

Co-authored-by: Alan <lethosor@users.noreply.github.com>

* Alphabetize changelog

* Update onMapLoad.default.init

* Update onMapLoad.init

* Update Core.rst

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Alan <lethosor@users.noreply.github.com>
2022-07-10 08:54:55 -07:00
Su 7653c2a932 document that script-paths.txt is only read at startup 2022-03-31 21:20:54 +01:00
lethosor 001e608aa7
Fix invalid role name
Resolves #1851

See https://github.com/sphinx-doc/sphinx/pull/8345 for details
2021-05-11 19:46:01 -04:00
myk002 49b34b52f5
update docs 2021-03-07 08:16:25 -08:00
myk002 dc58d39c36
document DFHACK_ENABLE_LUACOV env var 2021-03-07 08:16:24 -08:00
lethosor 0958fdbf4b
Document script paths
Ref #1690
2020-11-10 00:48:27 -05:00
lethosor 2382247398
Update some docs links to use HTTPS 2020-10-09 19:17:59 -04:00
lethosor c2280356cb
Set language of some code blocks to enable syntax highlighting 2020-10-09 01:15:42 -04:00
lethosor 655b363238
Fix some spelling errors 2020-07-22 02:23:29 -04:00
lethosor dfc9f78fa4
Refer to server config docs from dfhack-run 2020-07-21 23:14:59 -04:00
lethosor b34aa86d3c
Document remote server config 2020-07-21 21:41:41 -04:00
lethosor ba0f8553ed Misc updates, links 2020-07-08 23:46:38 -04:00
lethosor 24d64175fb Remove top-level links from TOCs 2020-07-08 02:13:37 -04:00
lethosor aff2944f28 Add "scripts-" prefix to generated scripts subpage anchors 2020-07-08 01:01:34 -04:00
lethosor a4384a9e98 Core.rst: add dfhack-run anchor, use more sensible example 2018-07-03 00:02:53 -04:00
lethosor 269d575267 Document environment variables 2018-02-11 03:07:25 -05:00
lethosor 789fc6dde0 Documentation tweaks
- Improve link in Binpatches.rst
- Fix `alias` anchor in Core.rst (ref #701)
- Increase depth of Plugins.rst table of contents. Some plugins were hard to
  find because they fit in multiple categories.
2017-06-23 12:44:34 -04:00
lethosor 0796fafb2a Add new built-in "alias" command
Closes #701
2017-06-19 00:15:20 -04:00
PeridexisErrant 468cca3f09 Improve docs on use of OS terminal for DFHack cmds 2016-08-13 13:42:12 +10:00
PeridexisErrant bb66ec6aee Add 'Using Commands' to docs, with pull#767 syntax
Plus consequential changes and minor updates to the table of contents.
2016-08-13 12:51:19 +10:00
PeridexisErrant b8bb8d0c92 Finish formatting, linking NEWS.rst 2016-04-11 09:30:05 +10: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 bc91928f8d Explain ":foo" parsing mode in Core notes 2015-11-06 11:58:33 +11: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
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 ddae19ad8b Move base scripts 2015-10-24 15:10:15 +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 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 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