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
50f0d11372
include tool desc in the index for all formats
2022-09-23 13:19:13 -07:00
4ae1b7fb74
fix anchor text transformation
2022-09-23 12:51:50 -07:00
98b6ad4954
fix index titles on pdf
2022-09-23 12:34:50 -07:00
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
52011bde7b
share tag list between tool and commands
...
so all relevant tag index entries get generated
2022-09-23 11:13:49 -07:00
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
35152bf022
create genindex entries for all tools and commands
2022-09-21 10:12:30 -07:00
c1154085cf
Fix tool name auto-detection for scripts in subfolders
2022-09-15 23:03:34 -04:00
25c99b5d1f
make summary text easier to read in text mode
2022-08-25 21:46:23 -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
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
83e1fa7de0
add summary text in its own paragraph element
2022-08-16 00:12:25 -07:00
b01ef4a962
add todos about not using strong for text output
2022-08-15 23:14:16 -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
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
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
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
b3a2a10caa
clean up generate doc dirs with ninja clean
2022-08-05 22:05:52 -07:00
8d99b7e6e1
prepare for plugin doc split
2022-07-10 20:19:09 -07:00
7c572ceec3
Make changelog "invalid line" errors include filename and location
...
e.g. for merge conflicts
2021-09-01 23:35:57 -04:00
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
14eeeeedc0
Remove extra paragraph from generated changelogs, restore paragraph margins
...
The CSS (changed in bca76b8f
2020-11-15 17:39:34 -05:00
a5f85e256d
Default to a basic DFHack-specific pygments lexer (supporting comments and prompts)
2020-10-09 00:27:22 -04:00
13380008c4
Update scripts, authors, changelog
2020-08-08 13:28:31 -04:00
89283026ae
Improve changelog error handling a bit when called from sphinx
2020-07-13 20:14:11 -04:00
b0fe96f6c7
Add gen_changelog.py compatibility shim, fix paths when run under cmake
2020-07-04 02:35:55 -04:00
f81f77352c
Restructure changelog generation as a Sphinx extension
2020-07-04 02:16:11 -04:00
lethosor
myk002