MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
11,663 Commits
1 Branch
0 Tags
40 MiB
Commit Graph

35 Commits (2fdbcaebf5641caaae318b1a7ee29336b486df45)

Author SHA1 Message Date
myk002 25c99b5d1f
make summary text easier to read in text mode 2022-08-25 21:46:23 -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 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
myk002 83e1fa7de0
add summary text in its own paragraph element 2022-08-16 00:12:25 -07:00
myk002 b01ef4a962
add todos about not using strong for text output 2022-08-15 23:14:16 -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 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 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 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 b3a2a10caa
clean up generate doc dirs with ninja clean 2022-08-05 22:05:52 -07:00
myk002 8d99b7e6e1
prepare for plugin doc split 2022-07-10 20:19:09 -07:00
lethosor 7c572ceec3
Make changelog "invalid line" errors include filename and location 
e.g. for merge conflicts
 2021-09-01 23:35:57 -04:00
lethosor debeac14c1
Stop reversing changelog entries 
This makes entries show up in the same order in the generated docs as in changelog.txt

The only other significant difference this causes is that when notes from multiple prereleases are combined into one stable release, changes from the newer version will show up first now (i.e. in the same order as reading the changelog from the top down), but this has minimal impact.
 2020-12-24 13:29:56 -05:00
lethosor 14eeeeedc0
Remove extra paragraph from generated changelogs, restore paragraph margins 
The CSS (changed in bca76b8f) was removing space between actual paragraphs in
lists. This was intended to address excess padding in changelogs, but that is
resolved here by removing blank lines surrounding nested lists. This still
displays properly on GitHub/Reddit and presumably other Markdown implementations
as well.
 2020-11-15 17:39:34 -05:00
lethosor a5f85e256d
Default to a basic DFHack-specific pygments lexer (supporting comments and prompts) 2020-10-09 00:27:22 -04:00
lethosor 13380008c4
Update scripts, authors, changelog 2020-08-08 13:28:31 -04:00
lethosor 89283026ae Improve changelog error handling a bit when called from sphinx 2020-07-13 20:14:11 -04:00
lethosor b0fe96f6c7 Add gen_changelog.py compatibility shim, fix paths when run under cmake 2020-07-04 02:35:55 -04:00
lethosor f81f77352c Restructure changelog generation as a Sphinx extension 2020-07-04 02:16:11 -04:00