Commit Graph

11537 Commits (f6699c0014dd231f8d2dc205183d9f5a0098dfc4)
 

Author SHA1 Message Date
Myk f6699c0014
Sync tags descriptions from spreadsheet 2022-08-13 13:40:14 -07:00
Myk c5afca1d18
Merge branch 'develop' into docs 2022-08-13 13:35:20 -07:00
Myk b21fc8aa75
remove extra space at bottom of tool summary 2022-08-13 13:32:45 -07:00
DFHack-Urist via GitHub Actions a01114a41b Auto-update submodules
scripts: master
2022-08-13 07:17:18 +00: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 4f799a152a
Merge branch 'docs-sphinx-tool-directive' into docs 2022-08-09 11:36:11 -04: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
pre-commit-ci[bot] 8f332c5925 [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-08-08 06:39:12 +00:00
Myk 3e9a916f4e
Merge branch 'develop' into docs 2022-08-07 23:38:00 -07:00
myk002 c0eb568d0d
Merge branch 'develop' into docs 2022-08-07 23:36:56 -07:00
myk002 7274a8cd2a
use docs/build.py to do the docs build
and add sphinx extension python files to the build deps
2022-08-07 23:35:00 -07:00
Myk 5b54f91d81
Merge pull request #2259 from myk002/myk_automelt
[automelt] remove un-useful command
2022-08-07 23:05:07 -07:00
myk002 22de8f6139
add secondary hotkey for gui/launcher 2022-08-07 22:50:47 -07:00
myk002 8930f30b72
remove unuseful command from automelt 2022-08-07 22:36:47 -07:00
myk002 ef56addb14
prep for new format; accept pipe as tag separator 2022-08-07 22:13:46 -07:00
pre-commit-ci[bot] f78e4276f9 [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-08-07 15:27:15 +00:00
myk002 a8d0cc7980
support scrolling by half pages in Label 2022-08-06 23:48:25 -07:00
myk002 153fef934b
clean up Label tests 2022-08-06 23:32:00 -07:00
lethosor 9098914ce4
Add --offline option to docs/build.py to disable image downloads 2022-08-06 22:47:38 -04:00
lethosor 69a84c23c2
renderer-msg: draw less often
suggested by Quietust
2022-08-06 12:33:25 -04:00
lethosor ac175affbc
Make renderer-msg draw somewhat more reliably
From g_src (enabler.cpp: renderer::display()), either update_all() or
update_tile() is called at least once per frame
2022-08-06 12:22:27 -04:00
DFHack-Urist via GitHub Actions c73200bf66 Auto-update submodules
scripts: master
2022-08-06 07:16:47 +00:00
pre-commit-ci[bot] 02a8f63ffc [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
2022-08-06 05:38:20 +00:00
myk002 6700a8d922
add missing keybinds for filltraffic plugin 2022-08-05 22:31:51 -07:00
myk002 625b4d439d
fix typo in API function name 2022-08-05 22:31:39 -07:00
myk002 d04beb0e4a
remove -E for sphinx-build. ninja clean can do it. 2022-08-05 22:21:14 -07:00
myk002 3e30b435fd
clean up docs build deps 2022-08-05 22:20:58 -07:00
myk002 1a777257b4
add get_entry_types API method to helpdb 2022-08-05 22:06:02 -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