Commit Graph

78 Commits (5e5de7e7c2d445bd498b0fcd32504a9ad7b82fde)

Author SHA1 Message Date
Myk d2c26acb47
create robots.txt for HTML docs 2022-11-20 17:08:02 -08:00
myk002 8546b2963c
tool docs are no longer toc-orphaned 2022-09-23 15:58:31 -07:00
myk002 1b9cd83009
use a domain index instead of the genindex 2022-09-23 10:10:28 -07:00
myk002 278b7528ac
implement basic domain index structure 2022-09-23 08:46:50 -07:00
Myk Taylor 2ef2ec66b6
update min sphinx version to 3.4.3
it might be able to go lower, but sphinx 1.8.6 is too low (it doesn't
support the calls we make to generate the genindex entries)
2022-09-21 09:57:55 -07:00
myk002 23994d4f4c
dynamically wrap helpdb long help text (default 80) 2022-09-11 13:41:20 -07:00
lethosor a4e70cf3e1
Remove now-unused dfhack-keybind role 2022-08-17 22:56:06 -04:00
myk002 524c49cb28
use easier to read underlining in text output 2022-08-16 00:12:08 -07:00
myk002 7acec133ba
organize tags by group, add more info about tools 2022-08-15 23:14:50 -07:00
myk002 f1f207b45b
don't include rst sources in html output 2022-08-13 21:51:36 -07: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 ed95db27f5
Move dfhack-keybind role to tool_docs.py and call from dfhack-command 2022-08-08 17:30:19 -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 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
lethosor 9098914ce4
Add --offline option to docs/build.py to disable image downloads 2022-08-06 22:47:38 -04:00
myk002 464f566928
update docs for stonesense 2022-07-31 13:41:29 -07:00
myk002 a09b35c2bd
ignore generated directories 2022-07-28 15:32:26 -07:00
lethosor 671f10e5d8
Fix write_file_if_changed() if target file does not exist 2022-07-27 01:04:47 -04:00
lethosor a8b40c5911
Drop Python 2 compat 2022-07-27 00:49:17 -04:00
lethosor 0fae25fc8b
Only write (most) generated rst files if they actually changed
Speeds up incremental builds significantly
2022-07-27 00:49:07 -04:00
myk002 93923e12f4
no need to mark the included file as an orphan 2022-07-22 15:31:58 -07:00
myk002 47af2ef396
exclude the generated included tags/ files 2022-07-22 15:28:09 -07:00
myk002 f9c8d36e03
mark the generated index as an orphan 2022-07-22 15:21:16 -07:00
myk002 e8ffa55dfe
use a label instead of a custom role
since I can't seem to figure out how to inject a link to a label via the
role processing code
2022-07-22 15:16:57 -07:00
myk002 6a31b316dc
add structure for category indices 2022-07-22 14:37:24 -07:00
myk002 bd58158126
get rid of tool TOC, use genindex
also add a stub role for dfhack-tag
2022-07-22 10:15:03 -07:00
myk002 b3679bef25
enable index building and update builtin docs 2022-07-21 23:21:56 -07:00
myk002 301c8e93a1
move builtin docs to individual files 2022-07-18 10:58:35 -07:00
myk002 585f6aad33
fix extra space within bold segment for keybindings 2022-07-15 15:45:03 -07:00
myk002 d68350c1f1
wrap text at 52 characters for in-game display 2022-07-11 17:24:17 -07:00
myk002 fdd406b722
ensure all files are reread on every docs build
this fixes the issue where the Stonesense docs were getting ignored
2022-07-10 20:19:12 -07:00
myk002 8d99b7e6e1
prepare for plugin doc split 2022-07-10 20:19:09 -07:00
Myk 27d7c3acc6
Myk sample command help (#2238)
* add example tool documentation in proposed format

* refine Tools.rst
2022-07-10 20:14:20 -07:00
Myk 28e15162a5
reorganize init scripts into dfhack-config (#2232)
* reorganize init scripts into dfhack-config

allows player init scripts to build on defaults instead of replace them
this also moves the init scripts out of the main df directory

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* escape asterisks in docs

* remove unneeded dfhack.init file creation for test

* write the test init script to the new init dir

* create the init dir before trying to write a file

* rename default init files for clarity

* Update changelog

* Update docs/changelog.txt

Co-authored-by: Alan <lethosor@users.noreply.github.com>

* Try to get buildmaster to work with old branches

* Update changelog

* get keybindings from all init scripts

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix spacing in changelog

* split default loading into its own file

* update docs with new changes

* update help text wording in default init files

* Apply suggestions from code review

Co-authored-by: Alan <lethosor@users.noreply.github.com>

* Alphabetize changelog

* Update onMapLoad.default.init

* Update onMapLoad.init

* Update Core.rst

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Alan <lethosor@users.noreply.github.com>
2022-07-10 08:54:55 -07:00
myk002 9c32a52cb0
actually ignore the script docs 2022-07-09 23:43:35 -07:00
myk002 c7107e9c23
ignore docs in the scripts repo 2022-07-09 23:34:57 -07:00
Myk b361a66a52
ensure our docs build cleanly with sphinx-5 (#2193)
* ensure our docs build cleanly with sphinx-5

* adapt to the API change in sphinx 5

while keeping compatibility with <5

* get rid of the extra colons in field lists
2022-06-17 09:35:31 -07:00
lethosor d1f0edd33b
Apply initial pre-commit config 2022-04-12 14:48:19 -04:00
lethosor 001e608aa7
Fix invalid role name
Resolves #1851

See https://github.com/sphinx-doc/sphinx/pull/8345 for details
2021-05-11 19:46:01 -04:00
lethosor 2382247398
Update some docs links to use HTTPS 2020-10-09 19:17:59 -04:00
lethosor a5f85e256d
Default to a basic DFHack-specific pygments lexer (supporting comments and prompts) 2020-10-09 00:27:22 -04:00
lethosor 09f262a0c2
Disable syntax highlighting in code blocks by default
The default is Python, which none (that I have found) of our code blocks use
2020-10-08 23:30:59 -04:00
lethosor 8dfdf75e7c
Add roles for links to source code on GitHub 2020-10-02 00:22:11 -04:00
lethosor ef53cac05b Improve chapter levels in the PDF build
"Quick links" was "Chapter 1", and everything else was nested under Chapter 2. This changes e.g. "2.6.5 DFHack Lua API" to "6.5: DFHack Lua API"
2020-07-15 21:19:37 -04:00
lethosor a8d34bb64e Add explicit home link to sidebar 2020-07-12 00:30:28 -04:00
lethosor fdb4487a36 Update Linux sphinx installation instructions, define substitution for minumum sphinx version 2020-07-10 02:11:03 -04:00
lethosor 24d64175fb Remove top-level links from TOCs 2020-07-08 02:13:37 -04:00
lethosor aff2944f28 Add "scripts-" prefix to generated scripts subpage anchors 2020-07-08 01:01:34 -04:00
lethosor f81f77352c Restructure changelog generation as a Sphinx extension 2020-07-04 02:16:11 -04:00
lethosor fa910cd74f Include custom CSS separately instead of overriding theme CSS
May help with https://github.com/DFHack/dfhack/issues/1578#issuecomment-635512324
2020-07-03 22:45:04 -04:00