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 |