d1f0edd33b
Apply initial pre-commit config
2022-04-12 14:48:19 -04:00
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
2382247398
Update some docs links to use HTTPS
2020-10-09 19:17:59 -04:00
a5f85e256d
Default to a basic DFHack-specific pygments lexer (supporting comments and prompts)
2020-10-09 00:27:22 -04:00
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
8dfdf75e7c
Add roles for links to source code on GitHub
2020-10-02 00:22:11 -04:00
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
a8d34bb64e
Add explicit home link to sidebar
2020-07-12 00:30:28 -04:00
fdb4487a36
Update Linux sphinx installation instructions, define substitution for minumum sphinx version
2020-07-10 02:11:03 -04:00
24d64175fb
Remove top-level links from TOCs
2020-07-08 02:13:37 -04:00
aff2944f28
Add "scripts-" prefix to generated scripts subpage anchors
2020-07-08 01:01:34 -04:00
f81f77352c
Restructure changelog generation as a Sphinx extension
2020-07-04 02:16:11 -04:00
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
9a3747d307
Make sidebar fixed
2020-07-03 20:42:23 -04:00
97a20acf1b
Add current year to docs copyright message
2020-06-17 20:32:30 -04:00
9e9e71cad7
Fix spacing in error message
2020-04-11 01:31:41 -04:00
a0ea756789
Add logo to docs
2018-05-12 11:02:34 -04:00
5ee73a5a73
Add an option to generate changelogs for individual versions
2018-04-05 11:55:25 -04:00
4158267edc
Ensure that docs/_auto/ exists
2018-04-02 14:14:03 -04:00
476483adb3
Add a script to automatically generate both changelogs from a single file
...
This avoids the need to manually copy entries between NEWS.rst and NEWS-dev.rst,
and also helps fix some inconsistencies automatically.
Pre-0.44.07 changelogs have not been converted yet.
2018-04-02 13:43:32 -04:00
4feab67a93
Fix Python 2 compatibility
...
Ref #972
2016-10-23 18:28:41 -04:00
951d293050
Add, use, and require auto docs for all keybindings
2016-10-20 18:33:31 +11:00
b211177a27
Fix version in docs for non-stable releases
2016-08-09 10:07:22 -04:00
cfaba3ec71
Update various references to scripts/ and mention old git issues in Compile.rst
2016-06-29 19:38:15 -04:00
27a84a8246
Move scripts to library/scripts
...
git can't cope with replacing scripts/3rdparty/* submodules with a single
scripts submodule.
2016-06-15 18:45:08 -04:00
cfc322fb7f
Improve handling of in-script documentation
...
Closes issue #823 . This allows for clean unification of html docs and
the in-terminal help text for scripts, including handling in core rather
than on a per-script basis (see issue #947 ).
2016-06-15 18:28:54 +10:00
c09b4f6b47
Tweak developer docs
2016-04-11 09:30:05 +10:00
99b93ecd11
Move index back to root
2015-11-07 19:42:18 -05:00
f7a768f349
Update conf.py
2015-11-07 18:46:26 -05:00
e176c3ea05
Merge remote-tracking branch 'PeridexisErrant/docs-again' into develop
2015-11-07 15:50:11 -05:00
a1110b36e8
Add shortlink for issues, update links
...
Also moved search above local table of contents in sidebar, which can
get very long.
2015-11-07 11:35:44 +11:00
5826b49d09
Move index.rst to docs directory
...
Having the docs index in the repo root was a holdover from when it was
the README file. Now that it's not much use without being built, it's
better to leave the root to README, NEWS, and LICENSE - especially when
one is a html shortcut to the docs index.
2015-11-06 17:09:56 +11:00
29533f1f08
Minor sphinx fixes
...
* Exclude build directories (rst files are copied into them by CPack)
* Fix CMake dependency path to conf.py
* Build in parallel
2015-11-05 22:57:09 -05:00
4cdfcbaa9b
Linting: improve script docs check, work off Travis
...
Expands coverage of scripts linting, and improves checks for a correct
title. Various fixes to make 'python travis/all.py' work for offline
users; when the TRAVIS envvar is not set it now fails without an error.
Minor cleanup in conf.py
2015-11-06 10:15:19 +11:00
6df0e26b05
Require 3rdparty docs to be in script source files
2015-11-02 09:32:50 +11:00
5643119c71
Get docs building online
...
Readthedocs runs the build command in the directory conf.py is found,
and to work correctly that has to be the root directory.
2015-10-29 14:26:37 +11:00
cc752a582e
Initial CMake version of Sphinx stuff.
2015-09-24 02:09:23 -04:00
79263847a6
Get version string for docs from CMakeLists.txt
...
Because it's better to have a single source.
Someone else will need to integrate the makefiles though.
2015-09-24 13:33:56 +10:00
eb5286dd86
Misc changes for better structure
2015-09-22 18:42:15 +10:00
336f8ee611
Name index.rst -> README.rst for Github integration
2015-09-22 18:26:56 +10:00
4a8bf96bd3
Standard basic sphinx setup
2015-09-22 17:42:15 +10:00
lethosor
PeridexisErrant
PeridexisErrant
expwnent