myk002
5a720bd496
update changelog
2022-11-07 15:40:00 -08:00
Josh Cooper
391553624f
Update changelog.txt
2022-11-06 17:34:53 -08:00
Myk
1e31cc197d
Merge branch 'develop' into spectate
2022-10-26 12:30:58 -07:00
Myk
c7f4f57367
Merge pull request #2360 from myk002/myk_automaterial_render
...
[automaterial] fix render errors with box boundaries
2022-10-26 12:25:48 -07:00
Myk
e60cbfc743
Merge pull request #2361 from myk002/myk_zjump_twbt
...
[mousequery] fix z-level jumps when clicking quickly
2022-10-26 12:25:40 -07:00
Josh Cooper
754e1dd4ac
Update docs/plugins/spectate.rst
2022-10-24 17:50:21 -07:00
myk002
8b61a17009
prevent z-level from changing after box select
...
if the player clicks the mouse too fast after finishing a selection
2022-10-24 12:46:31 -07:00
myk002
01c46f7a7e
fix z-level jumps when clicking quickly
...
this happens when TWBT is enabled and multilevel is > 0
getDepthAt() returns inconsistent values for the same position, leading
to a mismatch when we "unshift" the coordinates to account for render
depth
2022-10-24 12:44:25 -07:00
myk002
6a57cc4450
fix render errors with automaterial box boundaries
2022-10-24 12:41:17 -07:00
Josh Cooper
2ca2066081
Fixes underline in spectate.rst
2022-10-23 10:45:23 -07:00
Josh Cooper
c611a7615c
Merge branch 'develop' into spectate
2022-10-23 10:41:28 -07:00
Josh Cooper
c18beb30bb
Updates spectate.rst
2022-10-23 10:40:23 -07:00
Myk
a854e379b2
Merge pull request #2354 from myk002/myk_scrollbars_redux
...
make scrollbars more responsive when dragging
2022-10-22 20:28:52 -07:00
myk002
64b923b9eb
make the materials dialog filter lcase only
...
this allows the capital letter hotkeys to be processed by the list
widget without the special-casing of the ignore_keys attribute.
2022-10-21 12:43:53 -07:00
myk002
593b80cfa0
make scrollbars more responsive when dragging
2022-10-21 12:22:57 -07:00
Josh Cooper
f66dd6f404
Implements change requests
...
- removes redundant `if (df::global::ui)` checks; and tested to ensure no segfaults cropped up like in the past times I've removed these
- removes useless `if (pause_lock)` pause lock is set when plugin initializes, even if pause lock was left null (since we technically don't need it, and that was the point of the null check) it still would be a useless check (actually an impediment preventing functionality)
- removes disabled interpose code
- removes lua linkage
- updates doc
extra:
- surrounds user input for tick frequency with `std::abs()` not that we would have ended up with a negative value, but it was probably a typo and this is easier than printing an error or letting it underflow past max int (on most systems)
2022-10-20 23:52:30 -07:00
myk002
1e21e6546e
fix materials selection dialog
...
where the filter was swallowing the sublist hotkeys
2022-10-19 17:31:28 -07:00
myk002
666edd6d60
don't overwrite dig priority by accident
...
many callers of setDesignationAt simply didn't bother with the priority
parameter. change the default value of the priority param so that by
default we will keep the previous value instead of overwriting it
2022-10-19 16:47:54 -07:00
myk002
9199f8207f
add global keybinding for on-screen keyboard
2022-10-19 14:05:20 -07:00
myk002
43f4d4be39
fix typo in keybinding docs
2022-10-19 14:05:07 -07:00
Tachytaenius
82f759c56e
Single-character typo adjustment in Lua API.rst
2022-10-19 21:26:20 +01:00
Josh Cooper
9b1541add5
Merge branch 'develop' into spectate
2022-10-14 17:41:34 -07:00
Josh Cooper
45ac340f37
Finalizes spectate update
...
- Fixes for state transitions that were found broken. eg. plugin disabled -> enable auto-unpause feature -> enable plugin (auto-unpause will not truly be enabled; similar transitions were broken)
- Adds a commented out lock for if the pause code is ever adopted into the core API, as to enable many mods to use the `World::SetPauseState()` without walking over each other, and in the case of `reveal hell` also be able to avoid needing to set the state every tick in onupdate
- Revises the usage docs with `enable|disable|set` syntax
2022-10-14 17:02:43 -07:00
myk002
fbb4b37493
update changelog
2022-10-14 13:22:05 -07:00
myk002
fc926df59d
update changelog
2022-10-14 12:31:51 -07:00
myk002
b1bf80e585
support "group" file split strategy for blueprint
2022-10-14 12:27:24 -07:00
Myk
4f10cd4a9b
Merge pull request #2331 from wolfboyft/constructions-find-at-tile-patch
...
Implement/change/expose to Lua constructions findAtTile & insert
2022-10-13 17:40:21 -07:00
Tachytaenius
0b9b05e488
Add changelog entries
2022-10-13 20:51:01 +01:00
Josh Cooper
5c785d4bd7
Rewords spectate changelog entries
2022-10-13 11:57:25 -07:00
Josh Cooper
880e9b34ef
Removes disable usage
2022-10-13 11:52:56 -07:00
myk002
c52138b168
generate meta blueprints
2022-10-12 17:42:36 -07:00
myk002
f411ba76ba
record accurate room sizes in blueprints
2022-10-12 16:33:06 -07:00
myk002
b03911945d
update changelog
2022-10-12 16:03:03 -07:00
myk002
80d993e734
split rooms phase from query and record names
2022-10-12 16:01:54 -07:00
Josh Cooper
f54d37c8e7
Moved spectate changelog entries to new section
2022-10-12 14:42:04 -07:00
Josh Cooper
8d8ef023fd
Merge branch 'develop' into spectate
2022-10-12 14:40:56 -07:00
Josh Cooper
23c2d14b4a
Updated documentation/changelog
2022-10-12 14:40:21 -07:00
myk002
754f1a2598
update changelog
2022-10-12 13:33:29 -07:00
Tachytaenius
ded5f483d6
Fix issues in construction module
2022-10-12 21:32:27 +01:00
myk002
b78af72403
record built constructions in blueprint
2022-10-12 13:31:46 -07:00
Tachytaenius
1cf9688349
Implement/change/expose constructions findAtTile & insert (not building)
2022-10-12 21:10:22 +01:00
Josh Cooper
ddf7850d90
Merge branch 'develop' into spectate
2022-10-12 11:33:55 -07:00
myk002
598f2c4b12
support --smooth option for blueprints
2022-10-12 10:10:53 -07:00
myk002
9a0f9f210b
update docs for clicking and dragging scrollbars
2022-10-07 16:38:44 -07:00
myk002
ba36e72b33
support click and drag for scrollbars
2022-10-07 16:27:19 -07:00
myk002
35eb4e08dd
hold down the mouse button to continue scrolling
2022-10-07 15:40:05 -07:00
myk002
5722d6914b
transition Label to use the new generic Scrollbar
2022-10-07 12:45:43 -07:00
myk002
24232e894a
create Scrollbar widget and integrate with List
2022-10-06 11:13:16 -07:00
myk002
33816b8bc2
optionally process only the cur z-level and below
2022-10-05 14:01:09 -07:00
myk002
9817106c30
add --exclude option for ls
2022-10-05 13:30:14 -07:00
myk002
dc535004e9
better formatting for ls output for tags
2022-10-05 12:51:30 -07:00
Myk
8e9f3e902f
Update quickfort-user-guide.rst
...
Fix typo
2022-10-01 16:59:33 -07:00
myk002
3f6e92eda4
finalize 0.47.05-r7 release
2022-09-30 11:58:22 -07:00
myk002
663916b86b
update wording for autolabor
2022-09-28 14:56:20 -07:00
myk002
9a2cb5ea44
fix ALL the typos
...
done by copying everything into Google docs and running spellcheck
2022-09-28 14:49:03 -07:00
myk002
b6acf7a928
address feedback on the docs
2022-09-28 12:45:57 -07:00
myk002
cb80f7dd75
don't cache dup civzones when scanning buildings
2022-09-25 16:04:36 -07:00
Myk
54dc0e36f9
Merge pull request #2276 from lethosor/teleport-set-idle-area
...
`Units::teleport()`: set idle_area
2022-09-24 16:09:17 -07:00
lethosor
e9eeb5fda0
tool_docs: don't assume cwd is dfhack root
...
hopefully fixes the CI docs build in dfhack/scripts
2022-09-24 14:00:04 -04:00
lethosor
c1b9ffc7ca
Clarify changelog
...
Based on clarification from Doublestrafe and Quietust
2022-09-24 13:31:18 -04:00
lethosor
e6336e769a
Units::teleport(): set idle_area
2022-09-24 13:30:24 -04:00
myk002
6b219f342d
add a TOC of all tools so the pdf picks them up
2022-09-23 14:09:15 -07:00
myk002
50f0d11372
include tool desc in the index for all formats
2022-09-23 13:19:13 -07:00
myk002
4ae1b7fb74
fix anchor text transformation
2022-09-23 12:51:50 -07:00
myk002
98b6ad4954
fix index titles on pdf
2022-09-23 12:34:50 -07:00
myk002
1cd5e8657a
link directly to the tool page title
...
instead of the top of the page
this is especially important on mobile where the top of the page is
taken up with the sidebar boilerplate
2022-09-23 11:33:14 -07:00
myk002
52011bde7b
share tag list between tool and commands
...
so all relevant tag index entries get generated
2022-09-23 11:13:49 -07:00
myk002
5869ba64c8
add tag description to the tag index page
...
this is a terrible hack that only works because sphinx doesn't sanitize
its input for the html builder. we set the title to
'%s<h4>%s</h4>' % (tag, desc)
so the final html looks like <h1>adventure<h4>...</h4></h1>
this may not play nice with the pdf builder..
2022-09-23 10:21:53 -07:00
myk002
1b9cd83009
use a domain index instead of the genindex
2022-09-23 10:10:28 -07:00
myk002
a92e5d1f74
populate, merge, and generate real tag indices
2022-09-23 09:32:08 -07:00
myk002
a1d3fe77b5
add a bit more index infrastructure
2022-09-23 08:46:50 -07:00
myk002
278b7528ac
implement basic domain index structure
2022-09-23 08:46:50 -07:00
myk002
4913637b62
genindex label "alphabetical" -> "annotated"
2022-09-23 08:46:50 -07:00
myk002
618a191c87
fix directive use for reveal.rst
2022-09-23 08:46:50 -07:00
myk002
7c498e6611
add note about regenerating dwarfmonitor.json
2022-09-23 08:39:40 -07:00
Tachytaenius
6810f9bb90
Remove empty indented line
2022-09-22 20:31:43 +01:00
Tachytaenius
30100bec8f
Add link to Tachy Guns and show more code configurations in guide
2022-09-22 20:23:56 +01:00
myk002
2e64464bb8
reword sentence after title expansion
2022-09-21 10:44:01 -07:00
myk002
ee51e830ad
update wording in Tools docs
2022-09-21 10:40:17 -07:00
myk002
682ed29c0c
replace deprecated support page with a redirect
...
configured on the readthedocs web admin page
2022-09-21 10:36:46 -07:00
Myk Taylor
35152bf022
create genindex entries for all tools and commands
2022-09-21 10:12:30 -07:00
Josh Cooper
a3a06fb363
Update docs/plugins/spectate.rst
...
removes extra blank line
2022-09-19 10:23:18 -07:00
Myk Taylor
8e718d9851
add docs for dfhack.gui.getMousePos()
2022-09-18 13:31:20 -07:00
myk002
b084171048
add overlay docs
2022-09-16 21:56:04 -07:00
myk002
301563d1e6
update changelog
2022-09-16 21:56:04 -07:00
myk002
b7357204e6
ensure artifacts dir exists for docs build
2022-09-16 21:55:49 -07:00
myk002
170d7b9b51
typo fix in infiniteSky docs
2022-09-16 15:24:18 -07:00
lethosor
c1154085cf
Fix tool name auto-detection for scripts in subfolders
2022-09-15 23:03:34 -04:00
myk002
20919a8bb1
missed two upcased headers
2022-09-14 13:33:24 -07:00
myk002
9117d1bef6
fix casing and spacing in dev guide header
2022-09-14 13:21:16 -07:00
myk002
8a36d5607b
lcase section headers
2022-09-14 13:19:26 -07:00
myk002
d1acd45372
add syntax highlighting to code blocks
2022-09-14 13:19:10 -07:00
Tachytaenius
20a55299dd
Update modding-guide.rst
...
Add some potentially helpful comments to explain an inconsistenecy
2022-09-14 20:04:50 +01:00
Tachytaenius
ee123a2461
Update modding-guide.rst
...
Add missing slashes and change the wording to be more consistent in one part
2022-09-14 19:41:45 +01:00
Myk
d714274921
fix reqscript link name
2022-09-14 11:24:27 -07:00
Myk
b90126600f
whiiittespaaaace!!!
2022-09-14 11:00:26 -07:00
Myk
d5cfbf5e77
Merge branch 'develop' into modding-guide
2022-09-14 10:57:58 -07:00
Myk
7079fe7ea0
rewrap, fix a code syntax error
2022-09-14 10:56:58 -07:00
Myk
51f5349baf
labels must go above a section header
2022-09-14 10:43:51 -07:00
Myk
d68c17d070
fix paths/clean up code/use best practices
2022-09-14 10:33:27 -07:00
myk002
bb52e7bac8
list tools in categories with tags builtin
2022-09-13 23:17:19 -07:00
Myk
7ccacd7875
editing pass for the structure of a full mod
...
the sample code itself needs some adjustment to exemplify best pratices.
2022-09-13 23:16:54 -07:00
Tachytaenius
92b047fda1
Update modding-guide.rst
...
Obects to objects typo fix
2022-09-13 10:52:56 +01:00
Tachytaenius
b89a30a309
Update modding-guide.rst
...
Change use of word entities to objects because entitiy is a taken word in DF, and remove incorrect slash from a command.
2022-09-13 10:51:38 +01:00
Myk
cd83f3fcf1
Remove bad link
2022-09-12 15:04:16 -07:00
Myk
4a7faeef55
editing pass up through Custom raw tokens
2022-09-12 14:51:26 -07:00
myk002
0e30160c3c
update documentation documentation
2022-09-12 14:50:48 -07:00
Myk
540a2a9fa7
editing pass up through The structure of the game
2022-09-12 00:14:03 -07:00
Myk
253a1a80ad
add modding guide to guides index
2022-09-11 23:02:04 -07:00
Myk
04754b0a81
Merge branch 'develop' into modding-guide
2022-09-11 23:00:33 -07:00
myk002
d4914e7511
implement mouse click reactions for scrollbar
2022-09-11 19:33:01 -07:00
myk002
f71f034d1d
show full scrollbars instead of just scroll icons
2022-09-11 17:58:10 -07:00
Myk
09372680a2
Merge pull request #2281 from myk002/myk_helpdb_wrap
...
[helpdb] dynamically wrap long help text, preserving block indents
2022-09-11 14:40:43 -07:00
myk002
2311158792
fix reference to old ls param in Lua API docs
...
also add another example to the ls example commands
2022-09-11 14:06:21 -07:00
myk002
23994d4f4c
dynamically wrap helpdb long help text (default 80)
2022-09-11 13:41:20 -07:00
lethosor
bd51d9c455
Changelog entry for hideGuard
2022-09-10 15:34:17 -04:00
myk002
82e954692e
update changelog
2022-09-10 10:15:08 -07:00
myk002
cae2bca0a7
add dfhack.screen.hideGuard
2022-09-10 09:49:43 -07:00
myk002
2733ce7684
update workflow summary to match the gui version
2022-09-10 09:49:42 -07:00
myk002
a392a5371d
add keybinding for gui/workorder-details
2022-09-07 22:02:33 -07:00
myk002
040d018b8e
fix order of tree designation in autochop
2022-09-07 10:34:56 -07:00
myk002
86e1a8d59c
When smoothing walls, connect to doors and fgates
2022-09-07 10:11:51 -07:00
lethosor
483652e193
Rewrite utils.df_expr_to_ref() for consistency, add tests
2022-09-07 09:14:09 -07:00
myk002
e37b7650fa
update guides
...
including fixing the ordering of the TOC, which, while in alphabetical
order, was not in a logical order
2022-09-05 20:53:44 -07:00
myk002
73b7f13ad6
tombstone gui/assign-rack
2022-09-05 14:28:35 -07:00
myk002
c0682625f9
tombstone fix/merchants
2022-09-04 23:27:57 -07:00
myk002
df244cd519
tombstone fix/feeding-timers
2022-09-04 23:26:18 -07:00
myk002
d07bc349f8
tombstone fix/diplomats
2022-09-04 23:05:16 -07:00
myk002
e399e2205b
tombstone fix/fat-dwarves
2022-09-04 22:28:03 -07:00
myk002
446c321c62
fix spacing error
...
and floorplan error
2022-09-04 12:27:50 -07:00
Myk
ef1e85e6ff
Make doc docs match the docs
2022-09-03 20:00:38 -07:00
Josh Cooper
e24963a441
Updates changelog.txt with new Pause API under World module
2022-09-03 18:28:30 -07:00
Josh Cooper
a260e6992e
Reorders spectate code blocks, and adds persisting configuration
2022-09-03 17:02:57 -07:00
Josh Cooper
a06c1b1d07
Adds minor improvement to spectate documentation
2022-09-03 11:34:21 -07:00
Josh Cooper
b6c97214ca
Adds more features to spectate
2022-09-03 11:18:46 -07:00
myk002
bd4d17d205
update changelog
2022-09-01 22:48:18 -07:00
Josh Cooper
b3284c9d82
Updates spectate.rst
2022-09-01 17:14:10 -07:00
Josh Cooper
cd34749fec
Re-deletes Plugins.rst
2022-09-01 16:58:12 -07:00
Josh Cooper
33b92e6f69
Implements auto-unpause feature for spectate plugin
2022-09-01 16:53:26 -07:00
myk002
d258035b88
update changelog
2022-08-31 23:39:24 -07:00
myk002
b1a8662c4a
Merge branch 'develop' into docs
2022-08-31 23:00:39 -07:00
myk002
3d162a52ce
Add removed scripts to the graveyard
2022-08-31 22:47:43 -07:00
myk002
074a6ec5cd
allow EditFields to ignore specified keys
...
like "+" and "-", so you can use them as hotkeys in the parent view
2022-08-31 10:22:41 -07:00
myk002
8804dab182
update dreamfort traffic designations
2022-08-29 22:04:22 -07:00
Myk
29d4d530b5
Merge branch 'develop' into modding-guide
2022-08-27 09:00:53 -07:00
Tachytaenius
0b6178f5d2
Apply suggestions from code review
...
Co-authored-by: Myk <myk.taylor@gmail.com>
2022-08-27 15:24:22 +01:00
Tachytaenius
155525b853
Update Lua API.rst
2022-08-26 20:33:23 -07:00
Tachytaenius
306822b175
Update changelog.txt
2022-08-26 20:33:23 -07:00
myk002
65dd62a96e
remove unnecessary label for probe
2022-08-26 16:51:29 -07:00
myk002
b0ae9ed9c0
align quickfort guides with new defaults
2022-08-26 13:38:19 -07:00
myk002
0d3f5c2904
get new script docs to compile
2022-08-25 21:53:35 -07:00
myk002
25c99b5d1f
make summary text easier to read in text mode
2022-08-25 21:46:23 -07:00
myk002
95cd8f9d54
Merge branch 'develop' into docs
2022-08-19 15:36:07 -07:00
myk002
d0967b7e59
add alt-N keybinding for do-job-now
2022-08-19 09:34:38 -07:00
myk002
eb73de4670
make Usage a proper header
2022-08-17 22:42:02 -07:00
lethosor
72de1873e0
Improve keybinding rendering under the text builder
...
Previously rendered as e.g. "CtrlShiftK"
2022-08-17 23:18:58 -04:00
lethosor
fa8bceba93
Make paragraph labels render as plain text (not bold) under the text builder
2022-08-17 23:17:08 -04:00
lethosor
06c8269002
Update Documentation.rst with examples of dfhack-tool and dfhack-command
2022-08-17 23:04:17 -04:00
lethosor
a4e70cf3e1
Remove now-unused dfhack-keybind role
2022-08-17 22:56:06 -04:00
lethosor
7e0581204d
Refactor everything to use make_labeled_paragraph()
2022-08-17 22:37:03 -04:00
lethosor
fe7414baae
Make .dfhack-tool-summary styles consistent with Sphinx 5+
...
Under Sphinx 5, `topic` nodes now render as `<aside>` elements, and without an
explicit background color
2022-08-17 22:22:06 -04:00
myk002
22356e2fd6
resort tags according to new spreadsheet order
...
also fix tag syncing command so short descriptions with internal periods
are parsed correctly
2022-08-16 09:36:17 -07:00
myk002
4373f865a3
make `dfhack` a "when" tag
2022-08-16 08:23:48 -07:00
myk002
83e1fa7de0
add summary text in its own paragraph element
2022-08-16 00:12:25 -07:00
myk002
60458ad885
reorganize and alphabetize tags
2022-08-15 23:43:02 -07:00
myk002
7acec133ba
organize tags by group, add more info about tools
2022-08-15 23:14:50 -07:00
myk002
b01ef4a962
add todos about not using strong for text output
2022-08-15 23:14:16 -07:00
myk002
df9c37a8b7
Merge branch 'develop' into docs
2022-08-15 17:09:36 -07:00
myk002
8672282fd8
add helpdb, unit test, and document API
...
note that we have to dynamically sort some of the expected lists for
locale agnosticism
2022-08-15 16:31:52 -07:00
myk002
f7a0423566
update changelog
2022-08-15 16:27:43 -07:00
myk002
6fd0f4505f
add dfhack history repository and expose to lua
2022-08-15 16:27:43 -07:00
myk002
7dddb5e2ed
document widget mouse integration
2022-08-15 16:24:34 -07:00
myk002
7c3b06d71e
update changelog
2022-08-15 16:24:34 -07:00
myk002
79b6cd13e9
support scrolling by half pages in Label
2022-08-15 16:24:34 -07:00
myk002
0aa9a187cf
support cursor movement in EditFields
2022-08-15 16:24:34 -07:00
myk002
43b1abcdcf
support submit2 for EditFields
2022-08-15 16:24:34 -07:00
myk002
f400ee50f8
refine docs, logging, help text
2022-08-15 16:15:41 -07:00
myk002
a4c8535977
add argparse int checking methods, more docs
2022-08-15 16:15:41 -07:00
myk002
2f9021a3a0
move examples to the examples folder
2022-08-15 16:15:41 -07:00
myk002
9f648d532e
modify seedwatch all to actually watch all seeds
2022-08-15 16:11:13 -07:00
myk002
2a3a812b3c
update tag reference in Core.rst
2022-08-13 21:21:48 -07:00
myk002
eb91feff7c
revise tag list and assignments
2022-08-13 21:17:24 -07:00
Myk
f6699c0014
Sync tags descriptions from spreadsheet
2022-08-13 13:40:14 -07:00
Myk
b21fc8aa75
remove extra space at bottom of tool summary
2022-08-13 13:32:45 -07:00
myk002
f9930b313a
migrate all docs to the new directives
...
add a summary option for tools and commands so we can output them with
their tags and keybindings at the top of the file.
2022-08-09 22:37:24 -07:00
lethosor
2d60c543fd
Remove "Tool:" line
2022-08-08 21:22:55 -04:00
lethosor
e6b5d5b0c1
Remove commas from tag lists
2022-08-08 17:35:58 -04:00
lethosor
daf3bc516b
Switch to <topic> to fix line breaks in text output
...
No visible change in HTML output; PDF looks different but still acceptable
2022-08-08 17:32:42 -04:00
lethosor
6e29ddf2d3
Move space out of <strong> node for better text rendering
2022-08-08 17:32:42 -04:00
lethosor
1e7ce2602e
Shrink tool/command boxes somewhat
2022-08-08 17:32:42 -04:00
lethosor
6b32e008b3
Attempt to port keybinding documentation verification to new extension
...
Likely requires a sphinx Domain to work with parallel builds properly
2022-08-08 17:32:42 -04:00
lethosor
7651d301d2
Remove extra paragraph around keybindings
2022-08-08 17:32:41 -04:00
lethosor
5a14992aca
Use new directives for a few plugins
2022-08-08 17:32:40 -04:00
lethosor
ed95db27f5
Move dfhack-keybind role to tool_docs.py and call from dfhack-command
2022-08-08 17:30:19 -04:00
lethosor
5ef36d210f
Render implicit dfhack-command alongside dfhack-tool unless :no-command: is passed
2022-08-08 17:30:19 -04:00
lethosor
39e9288458
Render commands as literals
2022-08-08 17:30:18 -04:00
lethosor
b3d79f87cb
Fix optional name override
2022-08-08 17:30:18 -04:00
lethosor
d19ffa1806
Add stub dfhack-command directive, refactor to support
2022-08-08 17:30:18 -04:00
lethosor
12b3363b2c
Make dfhack-tool tags link to tag descriptions
2022-08-08 17:30:18 -04:00
lethosor
bb2ca0cc16
Render dfhack-tool as admonition
...
Getting a section header integrated is complicated, so might as well emulate
Mediawiki with a box-like element instead
2022-08-08 17:30:17 -04:00
lethosor
de5f4d3566
Default to document basename in dfhack-tool directive
2022-08-08 17:30:17 -04:00
lethosor
e47c681e9c
Use write_file_if_changed() in changelog.py
...
Speeds up incremental builds significantly
2022-08-08 17:30:17 -04:00
lethosor
89a88e94a9
Allow empty :tags:, give section a name to prevent errors
2022-08-08 17:30:17 -04:00
lethosor
d96260556e
Make title visible by putting it in its own section
2022-08-08 17:30:16 -04:00
lethosor
c44c8721c9
Initial attempt at dfhack-tool directive
...
Doesn't appear to produce headings that can be used as link targets...
2022-08-08 17:30:16 -04:00
myk002
a8d0cc7980
support scrolling by half pages in Label
2022-08-06 23:48:25 -07:00
lethosor
9098914ce4
Add --offline option to docs/build.py to disable image downloads
2022-08-06 22:47:38 -04:00
myk002
6700a8d922
add missing keybinds for filltraffic plugin
2022-08-05 22:31:51 -07:00
myk002
b3a2a10caa
clean up generate doc dirs with ninja clean
2022-08-05 22:05:52 -07:00
myk002
f7acc5cfc6
sync tags spreadsheet to git
...
spreadsheet - https://docs.google.com/spreadsheets/d/1hiDlo8M_bB_1jE-5HRs2RrrA_VZ4cRu9VXaTctX_nwk/edit#gid=170388995
sync command - for fname in *rst; do name=$(echo $fname | sed 's/[.]rst//'); tagline=$(egrep ",$name," ~/Downloads/DFHack\ taxonomy\ -\ Tool\ tags.csv | ~/Downloads/csvtotags.sh); sed -ri "s;[*]*Tags:.*;$tagline;" $fname; done
contents of csvtotags.sh -
fgrep . | sed -r 's/^[^,]+,([^,]+),[^.]+[.]"?,/\1,/' | awk -F, '
function tag(idx, tagname) {
if ($idx == "TRUE") {
if (hastag == 1) {printf(", ")}
printf("`tag/%s`", tagname)
hastag = 1
}
}
{
printf("%s", "**Tags:** ")
hastag = 0
tag(2, "adventure")
tag(3, "fort")
tag(4, "legends")
tag(5, "embark")
tag(6, "system")
tag(7, "dev")
tag(8, "auto")
tag(9, "productivity")
tag(10, "inspection")
tag(11, "design")
tag(12, "quickfort")
tag(13, "interface")
tag(14, "fps")
tag(15, "fix")
tag(16, "mod")
tag(17, "armok")
tag(18, "animals")
tag(19, "buildings")
tag(20, "items")
tag(21, "jobs")
tag(22, "map")
tag(23, "labors")
tag(24, "units")
tag(25, "stockpiles")
tag(26, "trees")
printf("\n")
}
'
2022-08-05 17:55:33 -07:00
myk002
ebfe00b112
editing pass of short descriptions
...
and fix some short description parsing
2022-08-05 10:08:23 -07:00
myk002
6f48c1f4d0
remove some cruft from autobutcher docs
2022-08-05 08:08:47 -07:00
myk002
46c3862a08
update docs for zone
2022-08-05 08:08:34 -07:00
pre-commit-ci[bot]
feed91d098
[pre-commit.ci] auto fixes from pre-commit.com hooks
...
for more information, see https://pre-commit.ci
2022-08-04 07:34:33 +00:00
Myk
8f242ac5cc
Update tweak.rst
2022-08-04 00:24:36 -07:00
Myk
5e9dde8a61
Update autobutcher.rst
2022-08-04 00:22:07 -07:00
Myk
26863fe468
Update zone.rst
2022-08-04 00:18:06 -07:00
myk002
5c9be942a5
update docs for workflow
2022-08-03 23:40:35 -07:00
myk002
b2ab93b3cd
update docs for autonestbox
2022-08-03 23:35:13 -07:00
myk002
3b17448597
update docs for autobutcher
2022-08-03 23:34:56 -07:00
myk002
03027b513a
Merge branch 'develop' into docs
2022-08-03 22:55:38 -07:00
myk002
9595e2152d
update changelog (fix typo)
2022-08-03 21:44:25 -07:00
myk002
db81538f63
update changelog
2022-08-03 21:44:25 -07:00
myk002
7e3acc410e
update changelog
2022-08-02 22:46:04 -07:00
myk002
d8f3e203e0
add image for stonesense
2022-07-31 13:41:30 -07:00
myk002
6686f703ae
update docs for workNow
2022-07-31 13:41:30 -07:00
myk002
e4c5b14670
update docs for tweak
2022-07-31 13:41:30 -07:00
myk002
a5a57a8631
update docs for tubefill
2022-07-31 13:41:30 -07:00
myk002
a6bdd9e3dc
update docs for trackstop
2022-07-31 13:41:30 -07:00
myk002
2362d60a3a
update docs for title-folder and title-version
2022-07-31 13:41:30 -07:00
myk002
51f79f9464
update docs for tiletypes
2022-07-31 13:41:30 -07:00
myk002
b240748684
update docs for tailor
2022-07-31 13:41:29 -07:00
myk002
3d0eab1a9b
update docs for strangemood
2022-07-31 13:41:29 -07:00
myk002
464f566928
update docs for stonesense
2022-07-31 13:41:29 -07:00
myk002
e1e245b4b4
update docs for stocks
2022-07-31 13:41:29 -07:00
myk002
5621a19278
update docs for stockpiles
2022-07-31 13:41:29 -07:00
myk002
08d434d16e
update docs for stockflow
2022-07-31 13:41:29 -07:00
myk002
479494e5a6
update docs for steam-engine
2022-07-31 13:41:29 -07:00
myk002
af0631cbd9
update docs for spectate
2022-07-31 13:41:29 -07:00
myk002
7261914826
update docs for sort
2022-07-31 13:41:29 -07:00
myk002
a1f937e354
update docs for siege-engine
2022-07-31 13:41:28 -07:00
myk002
8f7a23ee4d
update docs for showmood
2022-07-31 13:41:28 -07:00
myk002
edb7bd3168
update docs for seedwatch
2022-07-31 13:41:28 -07:00
myk002
feda5851e9
add example for ruby plugin
2022-07-31 13:41:28 -07:00
Myk
8cc0cee9a8
Fix grammar in power meter docs
2022-07-30 07:37:46 -07:00
myk002
f785a910ff
update docs for search
2022-07-29 17:38:23 -07:00
myk002
438293c0a0
update docs for reveal
2022-07-29 17:12:15 -07:00
myk002
c6d5fcb378
update docs for resume
2022-07-29 17:12:01 -07:00
myk002
a7011421b4
update docs for rendermax
2022-07-29 16:31:37 -07:00
myk002
eef7812bf6
update docs for rename
2022-07-29 16:08:00 -07:00
myk002
7a4e8ea18e
some plugins can't be directly enabled by the user
2022-07-29 16:05:49 -07:00
myk002
e513253d8d
update docs for regrass
2022-07-28 23:20:24 -07:00
myk002
1270cf3f0a
update docs for prospector
2022-07-28 23:12:11 -07:00
myk002
cf69a1a2cf
update docs for probe
2022-07-28 23:04:07 -07:00
myk002
1bbe996d58
update docs for power-meter
2022-07-28 22:55:20 -07:00
myk002
2d400fb571
update docs for plants
...
n.b. original docs were a lie.
2022-07-28 22:51:17 -07:00
myk002
2e2abbe87a
update docs for petcapRemover
...
and make it actually start running when it is enabled
2022-07-28 16:46:10 -07:00
myk002
380b003b56
fix list formatting for manipulator
2022-07-28 06:05:35 -07:00
myk002
4dea700ac9
Merge branch 'develop' into docs
2022-07-28 05:52:50 -07:00
myk002
b6e27b1875
fix rendering of quoted backtick
2022-07-28 05:46:25 -07:00
myk002
507b1632a2
support backtick as a keybinding
2022-07-28 05:45:50 -07:00
myk002
ac2d943fb1
remove commas from cleaners index entry
2022-07-28 05:41:29 -07:00
myk002
5954d7a19a
make docs for plug match the implementation
2022-07-28 05:32:30 -07:00
myk002
a6fb509cc7
convert table to list so it's readable in text rendering
2022-07-28 04:05:41 -07:00
myk002
e8bc9d9c0e
fix formatting in mousequery docs
2022-07-28 03:49:52 -07:00
myk002
5b8d8d7fe8
update docs for orders
2022-07-28 03:48:27 -07:00
myk002
88648284b0
update docs for nestboxes
2022-07-28 03:25:00 -07:00
myk002
f68b58c460
update docs for mousequery
2022-07-28 03:22:32 -07:00
myk002
bcab483b57
update docs for mode
2022-07-28 02:50:37 -07:00
myk002
b6f20ee61a
update docs for manipulator
2022-07-28 02:49:46 -07:00
myk002
756900393f
update docs for misery
2022-07-28 02:47:32 -07:00
myk002
6aabf5f3c3
no commas in index params
2022-07-28 02:47:32 -07:00
lethosor
a2bca50587
docs/build.py: Add support for xml and pseudoxml output formats
...
Useful for debugging layout of generated docutils nodes
2022-07-27 22:03:03 -04:00
myk002
ddae1aa900
update docs for liquids
2022-07-27 17:14:40 -07:00
myk002
52a0b0f2ca
update docs for lair
2022-07-27 17:14:30 -07:00
myk002
e94f1891c2
update docs for labormanager
2022-07-27 17:14:18 -07:00
myk002
58c0f94a2d
order autolabor docs similarly to labormanager
2022-07-27 17:14:00 -07:00
myk002
ed113466d9
update docs for isoworldremote
2022-07-27 16:29:54 -07:00
myk002
382ad84125
add example for job item-type
2022-07-27 16:14:24 -07:00
myk002
2008fd3955
update docs for jobutils.
...
I was unable to find an example usage for `job item-type`. I couldn't
find any combination of jobs or parameters that worked.
2022-07-27 16:03:49 -07:00
myk002
e677e8098d
add docs for plugins that only provide Lua apis
2022-07-27 15:48:11 -07:00
myk002
6293b71e9e
Revert "remove docs for non-enableable, command-less plugin"
...
This reverts commit c88423e655
.
2022-07-26 22:01:39 -07:00
myk002
c88423e655
remove docs for non-enableable, command-less plugin
2022-07-25 22:05:32 -07:00
myk002
4438134711
add missing keybinding for infiniteSky
2022-07-25 22:01:28 -07:00
myk002
06fc84fb39
update docs for infiniteSky
2022-07-25 22:00:56 -07:00
myk002
69d88a62dd
update docs for hotkeys
2022-07-25 21:54:34 -07:00
myk002
b93e3365f6
update docs for get plants
2022-07-25 21:50:52 -07:00
myk002
094f8d7257
fix typos in forceequip cpp/docs
2022-07-25 16:57:08 -07:00
myk002
367ac0064e
update docs for generated-creature-renamer
2022-07-25 16:54:28 -07:00
myk002
eb0f016804
update docs for forceequip
2022-07-25 16:40:19 -07:00
myk002
82953d8b2f
fix doc build errors
2022-07-25 13:37:52 -07:00
myk002
20ccd3a99c
update docs for follow
2022-07-25 10:55:31 -07:00
myk002
e13aae2ce1
update docs for flows
2022-07-25 10:55:04 -07:00
myk002
ea3dfe399e
update docs for fixveins
2022-07-25 10:54:11 -07:00
myk002
9c0bd6bd70
update docs for fix-unit-occupancy
2022-07-25 10:23:26 -07:00
myk002
2654de583f
update docs for filltraffic
2022-07-25 10:23:05 -07:00
myk002
ab9c3a07c4
add missing 'enable' usage for dwarfmonitor
2022-07-25 10:22:42 -07:00
myk002
989befa582
update docs for fastdwarf
2022-07-25 10:22:23 -07:00
myk002
a6cb79c237
remove defunct tool fix-armory
2022-07-25 10:21:59 -07:00
myk002
886289d805
update docs for fix-armory
2022-07-25 10:21:33 -07:00
myk002
38c17b5215
update docs for RemoteFortressReader
2022-07-25 06:56:21 -07:00
myk002
6b1c0b5308
rename building-hacks section
2022-07-25 06:53:08 -07:00
myk002
4132dbdbbb
remove docs for no-command, un-enableable plugin
...
it's already documented in lua-api
2022-07-25 06:51:40 -07:00
myk002
98ad22dddd
align remaining plugin docs to plugin names
2022-07-25 06:08:59 -07:00
myk002
02cc085a43
update docs for embark-tools
2022-07-24 23:59:04 -07:00
myk002
d94fef36ff
update docs for embark-assistant
2022-07-24 23:39:13 -07:00
myk002
32e2ac2103
update docs for dwarfvet
2022-07-24 23:24:52 -07:00
myk002
595fb221b8
code block is not valid json
2022-07-24 23:24:35 -07:00
myk002
ac11cde213
update docs for dwarfmonitor
2022-07-24 23:22:51 -07:00
Myk
d624e91673
Fix missing newline
2022-07-24 20:59:24 -07:00
myk002
b2ca3cb194
update docs for diggingInvaders
2022-07-24 20:12:04 -07:00
myk002
60b599865c
update docs for digFlood
2022-07-24 17:01:50 -07:00
myk002
ca06d1d9c5
update docs for dig (again)
2022-07-24 16:08:35 -07:00
myk002
9dd62f2291
update docs for dig
2022-07-23 22:40:33 -07:00
myk002
5f56d79235
move dfhack.history to dfhack-config/dfhack.history
2022-07-23 21:55:49 -07:00
myk002
947889873d
update all docs I've done so far to new standards
2022-07-23 16:03:40 -07:00
myk002
e4273589e1
one fewer char per line so no horiz scrolling
2022-07-23 15:38:35 -07:00
myk002
a94f3c3cca
fix some formatting
2022-07-23 15:32:08 -07:00
lethosor
c1a694cb18
Improve syntax highlighting in Documentation.rst
2022-07-23 18:26:40 -04:00
myk002
62523bdcb1
update documentation for the documentation
2022-07-23 15:13:11 -07:00
myk002
3141ecbec2
remove cromulate. it has outlived its purpose
2022-07-22 21:04:22 -07:00
myk002
5dde613a12
fix formatting errors
2022-07-22 19:06:50 -07:00
myk002
a7346dd05b
add missing labels
2022-07-22 17:51:48 -07:00
myk002
4cb57d25f1
update dig-now docs
2022-07-22 17:46:33 -07:00
myk002
675f2edee2
update deramp docs
2022-07-22 17:46:22 -07:00
myk002
0f3811b933
update debugfilter docs
2022-07-22 17:46:11 -07:00
myk002
65b3ce6e96
remove unattached docs and plugins
2022-07-22 17:45:23 -07:00
myk002
19a4905933
update docs for "c" plugins
2022-07-22 16:42:36 -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
2fd6d528ce
move support docs to the intro page
...
but leave an orphan link to the new section in case external links still
point to the old page
2022-07-22 14:37:47 -07:00
myk002
6a31b316dc
add structure for category indices
2022-07-22 14:37:24 -07:00
myk002
b38ccfe03d
fix typo in automaterial docs
2022-07-22 10:18:32 -07:00
myk002
d637c87496
ensure all plugins are indexed
2022-07-22 10:15:03 -07:00
myk002
3175e8b33d
update tags and text for builtins
2022-07-22 10:15:03 -07:00
myk002
bd58158126
get rid of tool TOC, use genindex
...
also add a stub role for dfhack-tag
2022-07-22 10:15:03 -07:00
myk002
9c7731f072
remove reference to dfhack.init-example
2022-07-22 10:15:03 -07:00
pre-commit-ci[bot]
3522b89f5c
[pre-commit.ci] auto fixes from pre-commit.com hooks
...
for more information, see https://pre-commit.ci
2022-07-22 14:20:02 +00:00
myk002
53cdf57043
add missing digv label
2022-07-22 00:08:03 -07:00
myk002
6b9803daaf
update docs up to the end of the b's
2022-07-22 00:05:53 -07:00
myk002
b3679bef25
enable index building and update builtin docs
2022-07-21 23:21:56 -07:00
lethosor
5521a5a45d
Remove old build*.sh scripts
2022-07-22 00:47:33 -04:00
lethosor
4b0b0e02f8
Update Documentation.rst for new workflow and output formats
2022-07-22 00:46:44 -04:00
lethosor
68b8837a8d
Replace docs/build*.sh with more flexible build.py
...
Notable changes:
- can build any combination of output formats in series
- `-E` is no longer passed by default to aid in development, but can be passed
manually
2022-07-22 00:30:36 -04:00
myk002
d9a1104473
update docs for cleanowned
2022-07-20 14:51:06 -07:00
myk002
e9e477c680
update docs for clean and spotclean
2022-07-20 13:51:03 -07:00
myk002
1f3c4cdd18
update docs for cleanconst
2022-07-20 13:26:30 -07:00
myk002
d3dd12c38f
update docs for changevein
2022-07-20 13:24:27 -07:00
myk002
fae5f0635a
update docs for changelayer
2022-07-20 13:21:05 -07:00
myk002
ddd2e5003a
update docs for changeitem
2022-07-20 13:00:27 -07:00