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
1b9cd83009
use a domain index instead of the genindex
2022-09-23 10:10:28 -07:00
a92e5d1f74
populate, merge, and generate real tag indices
2022-09-23 09:32:08 -07:00
a1d3fe77b5
add a bit more index infrastructure
2022-09-23 08:46:50 -07:00
278b7528ac
implement basic domain index structure
2022-09-23 08:46:50 -07:00
4913637b62
genindex label "alphabetical" -> "annotated"
2022-09-23 08:46:50 -07:00
618a191c87
fix directive use for reveal.rst
2022-09-23 08:46:50 -07:00
7c498e6611
add note about regenerating dwarfmonitor.json
2022-09-23 08:39:40 -07:00
6810f9bb90
Remove empty indented line
2022-09-22 20:31:43 +01:00
30100bec8f
Add link to Tachy Guns and show more code configurations in guide
2022-09-22 20:23:56 +01:00
2e64464bb8
reword sentence after title expansion
2022-09-21 10:44:01 -07:00
ee51e830ad
update wording in Tools docs
2022-09-21 10:40:17 -07:00
682ed29c0c
replace deprecated support page with a redirect
...
configured on the readthedocs web admin page
2022-09-21 10:36:46 -07:00
35152bf022
create genindex entries for all tools and commands
2022-09-21 10:12:30 -07:00
a3a06fb363
Update docs/plugins/spectate.rst
...
removes extra blank line
2022-09-19 10:23:18 -07:00
8e718d9851
add docs for dfhack.gui.getMousePos()
2022-09-18 13:31:20 -07:00
b084171048
add overlay docs
2022-09-16 21:56:04 -07:00
301563d1e6
update changelog
2022-09-16 21:56:04 -07:00
b7357204e6
ensure artifacts dir exists for docs build
2022-09-16 21:55:49 -07:00
170d7b9b51
typo fix in infiniteSky docs
2022-09-16 15:24:18 -07:00
c1154085cf
Fix tool name auto-detection for scripts in subfolders
2022-09-15 23:03:34 -04:00
20919a8bb1
missed two upcased headers
2022-09-14 13:33:24 -07:00
9117d1bef6
fix casing and spacing in dev guide header
2022-09-14 13:21:16 -07:00
8a36d5607b
lcase section headers
2022-09-14 13:19:26 -07:00
d1acd45372
add syntax highlighting to code blocks
2022-09-14 13:19:10 -07:00
20a55299dd
Update modding-guide.rst
...
Add some potentially helpful comments to explain an inconsistenecy
2022-09-14 20:04:50 +01:00
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
d714274921
fix reqscript link name
2022-09-14 11:24:27 -07:00
b90126600f
whiiittespaaaace!!!
2022-09-14 11:00:26 -07:00
d5cfbf5e77
Merge branch 'develop' into modding-guide
2022-09-14 10:57:58 -07:00
7079fe7ea0
rewrap, fix a code syntax error
2022-09-14 10:56:58 -07:00
51f5349baf
labels must go above a section header
2022-09-14 10:43:51 -07:00
d68c17d070
fix paths/clean up code/use best practices
2022-09-14 10:33:27 -07:00
bb52e7bac8
list tools in categories with tags builtin
2022-09-13 23:17:19 -07:00
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
92b047fda1
Update modding-guide.rst
...
Obects to objects typo fix
2022-09-13 10:52:56 +01:00
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
cd83f3fcf1
Remove bad link
2022-09-12 15:04:16 -07:00
4a7faeef55
editing pass up through Custom raw tokens
2022-09-12 14:51:26 -07:00
0e30160c3c
update documentation documentation
2022-09-12 14:50:48 -07:00
540a2a9fa7
editing pass up through The structure of the game
2022-09-12 00:14:03 -07:00
253a1a80ad
add modding guide to guides index
2022-09-11 23:02:04 -07:00
04754b0a81
Merge branch 'develop' into modding-guide
2022-09-11 23:00:33 -07:00
d4914e7511
implement mouse click reactions for scrollbar
2022-09-11 19:33:01 -07:00
f71f034d1d
show full scrollbars instead of just scroll icons
2022-09-11 17:58:10 -07:00
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
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
23994d4f4c
dynamically wrap helpdb long help text (default 80)
2022-09-11 13:41:20 -07:00
bd51d9c455
Changelog entry for hideGuard
2022-09-10 15:34:17 -04:00
82e954692e
update changelog
2022-09-10 10:15:08 -07:00
cae2bca0a7
add dfhack.screen.hideGuard
2022-09-10 09:49:43 -07:00
2733ce7684
update workflow summary to match the gui version
2022-09-10 09:49:42 -07:00
a392a5371d
add keybinding for gui/workorder-details
2022-09-07 22:02:33 -07:00
040d018b8e
fix order of tree designation in autochop
2022-09-07 10:34:56 -07:00
86e1a8d59c
When smoothing walls, connect to doors and fgates
2022-09-07 10:11:51 -07:00
483652e193
Rewrite utils.df_expr_to_ref() for consistency, add tests
2022-09-07 09:14:09 -07:00
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
73b7f13ad6
tombstone gui/assign-rack
2022-09-05 14:28:35 -07:00
c0682625f9
tombstone fix/merchants
2022-09-04 23:27:57 -07:00
df244cd519
tombstone fix/feeding-timers
2022-09-04 23:26:18 -07:00
d07bc349f8
tombstone fix/diplomats
2022-09-04 23:05:16 -07:00
e399e2205b
tombstone fix/fat-dwarves
2022-09-04 22:28:03 -07:00
446c321c62
fix spacing error
...
and floorplan error
2022-09-04 12:27:50 -07:00
ef1e85e6ff
Make doc docs match the docs
2022-09-03 20:00:38 -07:00
e24963a441
Updates changelog.txt with new Pause API under World module
2022-09-03 18:28:30 -07:00
a260e6992e
Reorders spectate code blocks, and adds persisting configuration
2022-09-03 17:02:57 -07:00
a06c1b1d07
Adds minor improvement to spectate documentation
2022-09-03 11:34:21 -07:00
b6c97214ca
Adds more features to spectate
2022-09-03 11:18:46 -07:00
bd4d17d205
update changelog
2022-09-01 22:48:18 -07:00
b3284c9d82
Updates spectate.rst
2022-09-01 17:14:10 -07:00
cd34749fec
Re-deletes Plugins.rst
2022-09-01 16:58:12 -07:00
33b92e6f69
Implements auto-unpause feature for spectate plugin
2022-09-01 16:53:26 -07:00
d258035b88
update changelog
2022-08-31 23:39:24 -07:00
b1a8662c4a
Merge branch 'develop' into docs
2022-08-31 23:00:39 -07:00
3d162a52ce
Add removed scripts to the graveyard
2022-08-31 22:47:43 -07:00
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
8804dab182
update dreamfort traffic designations
2022-08-29 22:04:22 -07:00
29d4d530b5
Merge branch 'develop' into modding-guide
2022-08-27 09:00:53 -07:00
0b6178f5d2
Apply suggestions from code review
...
Co-authored-by: Myk <myk.taylor@gmail.com>
2022-08-27 15:24:22 +01:00
155525b853
Update Lua API.rst
2022-08-26 20:33:23 -07:00
306822b175
Update changelog.txt
2022-08-26 20:33:23 -07:00
65dd62a96e
remove unnecessary label for probe
2022-08-26 16:51:29 -07:00
b0ae9ed9c0
align quickfort guides with new defaults
2022-08-26 13:38:19 -07:00
0d3f5c2904
get new script docs to compile
2022-08-25 21:53:35 -07:00
25c99b5d1f
make summary text easier to read in text mode
2022-08-25 21:46:23 -07:00
95cd8f9d54
Merge branch 'develop' into docs
2022-08-19 15:36:07 -07:00
d0967b7e59
add alt-N keybinding for do-job-now
2022-08-19 09:34:38 -07:00
eb73de4670
make Usage a proper header
2022-08-17 22:42:02 -07:00
72de1873e0
Improve keybinding rendering under the text builder
...
Previously rendered as e.g. "CtrlShiftK"
2022-08-17 23:18:58 -04:00
fa8bceba93
Make paragraph labels render as plain text (not bold) under the text builder
2022-08-17 23:17:08 -04:00
06c8269002
Update Documentation.rst with examples of dfhack-tool and dfhack-command
2022-08-17 23:04:17 -04:00
a4e70cf3e1
Remove now-unused dfhack-keybind role
2022-08-17 22:56:06 -04:00
7e0581204d
Refactor everything to use make_labeled_paragraph()
2022-08-17 22:37:03 -04:00
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
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
4373f865a3
make `dfhack` a "when" tag
2022-08-16 08:23:48 -07:00
83e1fa7de0
add summary text in its own paragraph element
2022-08-16 00:12:25 -07:00
60458ad885
reorganize and alphabetize tags
2022-08-15 23:43:02 -07:00
7acec133ba
organize tags by group, add more info about tools
2022-08-15 23:14:50 -07:00
b01ef4a962
add todos about not using strong for text output
2022-08-15 23:14:16 -07:00
df9c37a8b7
Merge branch 'develop' into docs
2022-08-15 17:09:36 -07:00
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
f7a0423566
update changelog
2022-08-15 16:27:43 -07:00
6fd0f4505f
add dfhack history repository and expose to lua
2022-08-15 16:27:43 -07:00
7dddb5e2ed
document widget mouse integration
2022-08-15 16:24:34 -07:00
7c3b06d71e
update changelog
2022-08-15 16:24:34 -07:00
79b6cd13e9
support scrolling by half pages in Label
2022-08-15 16:24:34 -07:00
0aa9a187cf
support cursor movement in EditFields
2022-08-15 16:24:34 -07:00
43b1abcdcf
support submit2 for EditFields
2022-08-15 16:24:34 -07:00
f400ee50f8
refine docs, logging, help text
2022-08-15 16:15:41 -07:00
a4c8535977
add argparse int checking methods, more docs
2022-08-15 16:15:41 -07:00
2f9021a3a0
move examples to the examples folder
2022-08-15 16:15:41 -07:00
9f648d532e
modify seedwatch all to actually watch all seeds
2022-08-15 16:11:13 -07:00
2a3a812b3c
update tag reference in Core.rst
2022-08-13 21:21:48 -07:00
eb91feff7c
revise tag list and assignments
2022-08-13 21:17:24 -07:00
f6699c0014
Sync tags descriptions from spreadsheet
2022-08-13 13:40:14 -07:00
b21fc8aa75
remove extra space at bottom of tool summary
2022-08-13 13:32:45 -07:00
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
2d60c543fd
Remove "Tool:" line
2022-08-08 21:22:55 -04:00
e6b5d5b0c1
Remove commas from tag lists
2022-08-08 17:35:58 -04:00
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
6e29ddf2d3
Move space out of <strong> node for better text rendering
2022-08-08 17:32:42 -04:00
1e7ce2602e
Shrink tool/command boxes somewhat
2022-08-08 17:32:42 -04:00
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
7651d301d2
Remove extra paragraph around keybindings
2022-08-08 17:32:41 -04:00
5a14992aca
Use new directives for a few plugins
2022-08-08 17:32:40 -04:00
ed95db27f5
Move dfhack-keybind role to tool_docs.py and call from dfhack-command
2022-08-08 17:30:19 -04:00
5ef36d210f
Render implicit dfhack-command alongside dfhack-tool unless :no-command: is passed
2022-08-08 17:30:19 -04:00
39e9288458
Render commands as literals
2022-08-08 17:30:18 -04:00
b3d79f87cb
Fix optional name override
2022-08-08 17:30:18 -04:00
d19ffa1806
Add stub dfhack-command directive, refactor to support
2022-08-08 17:30:18 -04:00
12b3363b2c
Make dfhack-tool tags link to tag descriptions
2022-08-08 17:30:18 -04:00
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
de5f4d3566
Default to document basename in dfhack-tool directive
2022-08-08 17:30:17 -04:00
e47c681e9c
Use write_file_if_changed() in changelog.py
...
Speeds up incremental builds significantly
2022-08-08 17:30:17 -04:00
89a88e94a9
Allow empty :tags:, give section a name to prevent errors
2022-08-08 17:30:17 -04:00
d96260556e
Make title visible by putting it in its own section
2022-08-08 17:30:16 -04:00
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
a8d0cc7980
support scrolling by half pages in Label
2022-08-06 23:48:25 -07:00
9098914ce4
Add --offline option to docs/build.py to disable image downloads
2022-08-06 22:47:38 -04:00
6700a8d922
add missing keybinds for filltraffic plugin
2022-08-05 22:31:51 -07:00
b3a2a10caa
clean up generate doc dirs with ninja clean
2022-08-05 22:05:52 -07:00
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
ebfe00b112
editing pass of short descriptions
...
and fix some short description parsing
2022-08-05 10:08:23 -07:00
6f48c1f4d0
remove some cruft from autobutcher docs
2022-08-05 08:08:47 -07:00
46c3862a08
update docs for zone
2022-08-05 08:08:34 -07:00
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
8f242ac5cc
Update tweak.rst
2022-08-04 00:24:36 -07:00
5e9dde8a61
Update autobutcher.rst
2022-08-04 00:22:07 -07:00
26863fe468
Update zone.rst
2022-08-04 00:18:06 -07:00
5c9be942a5
update docs for workflow
2022-08-03 23:40:35 -07:00
b2ab93b3cd
update docs for autonestbox
2022-08-03 23:35:13 -07:00
3b17448597
update docs for autobutcher
2022-08-03 23:34:56 -07:00
03027b513a
Merge branch 'develop' into docs
2022-08-03 22:55:38 -07:00
9595e2152d
update changelog (fix typo)
2022-08-03 21:44:25 -07:00
db81538f63
update changelog
2022-08-03 21:44:25 -07:00
7e3acc410e
update changelog
2022-08-02 22:46:04 -07:00
d8f3e203e0
add image for stonesense
2022-07-31 13:41:30 -07:00
6686f703ae
update docs for workNow
2022-07-31 13:41:30 -07:00
e4c5b14670
update docs for tweak
2022-07-31 13:41:30 -07:00
a5a57a8631
update docs for tubefill
2022-07-31 13:41:30 -07:00
a6bdd9e3dc
update docs for trackstop
2022-07-31 13:41:30 -07:00
2362d60a3a
update docs for title-folder and title-version
2022-07-31 13:41:30 -07:00
51f79f9464
update docs for tiletypes
2022-07-31 13:41:30 -07:00
b240748684
update docs for tailor
2022-07-31 13:41:29 -07:00
3d0eab1a9b
update docs for strangemood
2022-07-31 13:41:29 -07:00
464f566928
update docs for stonesense
2022-07-31 13:41:29 -07:00
e1e245b4b4
update docs for stocks
2022-07-31 13:41:29 -07:00
5621a19278
update docs for stockpiles
2022-07-31 13:41:29 -07:00
08d434d16e
update docs for stockflow
2022-07-31 13:41:29 -07:00
479494e5a6
update docs for steam-engine
2022-07-31 13:41:29 -07:00
af0631cbd9
update docs for spectate
2022-07-31 13:41:29 -07:00
7261914826
update docs for sort
2022-07-31 13:41:29 -07:00
a1f937e354
update docs for siege-engine
2022-07-31 13:41:28 -07:00
8f7a23ee4d
update docs for showmood
2022-07-31 13:41:28 -07:00
edb7bd3168
update docs for seedwatch
2022-07-31 13:41:28 -07:00
feda5851e9
add example for ruby plugin
2022-07-31 13:41:28 -07:00
8cc0cee9a8
Fix grammar in power meter docs
2022-07-30 07:37:46 -07:00
f785a910ff
update docs for search
2022-07-29 17:38:23 -07:00
438293c0a0
update docs for reveal
2022-07-29 17:12:15 -07:00
c6d5fcb378
update docs for resume
2022-07-29 17:12:01 -07:00
a7011421b4
update docs for rendermax
2022-07-29 16:31:37 -07:00
eef7812bf6
update docs for rename
2022-07-29 16:08:00 -07:00
7a4e8ea18e
some plugins can't be directly enabled by the user
2022-07-29 16:05:49 -07:00
e513253d8d
update docs for regrass
2022-07-28 23:20:24 -07:00
1270cf3f0a
update docs for prospector
2022-07-28 23:12:11 -07:00
cf69a1a2cf
update docs for probe
2022-07-28 23:04:07 -07:00
1bbe996d58
update docs for power-meter
2022-07-28 22:55:20 -07:00
2d400fb571
update docs for plants
...
n.b. original docs were a lie.
2022-07-28 22:51:17 -07:00
2e2abbe87a
update docs for petcapRemover
...
and make it actually start running when it is enabled
2022-07-28 16:46:10 -07:00
380b003b56
fix list formatting for manipulator
2022-07-28 06:05:35 -07:00
4dea700ac9
Merge branch 'develop' into docs
2022-07-28 05:52:50 -07:00
b6e27b1875
fix rendering of quoted backtick
2022-07-28 05:46:25 -07:00
507b1632a2
support backtick as a keybinding
2022-07-28 05:45:50 -07:00
ac2d943fb1
remove commas from cleaners index entry
2022-07-28 05:41:29 -07:00
5954d7a19a
make docs for plug match the implementation
2022-07-28 05:32:30 -07:00
a6fb509cc7
convert table to list so it's readable in text rendering
2022-07-28 04:05:41 -07:00
e8bc9d9c0e
fix formatting in mousequery docs
2022-07-28 03:49:52 -07:00
5b8d8d7fe8
update docs for orders
2022-07-28 03:48:27 -07:00
88648284b0
update docs for nestboxes
2022-07-28 03:25:00 -07:00
myk002
Tachytaenius
Josh Cooper
lethosor
Myk
Josh Cooper
pre-commit-ci[bot]