Commit Graph

79 Commits (3619230a50fc3176ac2d6cfda61729dd634ced25)

Author SHA1 Message Date
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
lethosor 9a3747d307 Make sidebar fixed 2020-07-03 20:42:23 -04:00
lethosor 97a20acf1b Add current year to docs copyright message 2020-06-17 20:32:30 -04:00
lethosor 9e9e71cad7 Fix spacing in error message 2020-04-11 01:31:41 -04:00
lethosor a0ea756789 Add logo to docs 2018-05-12 11:02:34 -04:00
lethosor 5ee73a5a73 Add an option to generate changelogs for individual versions 2018-04-05 11:55:25 -04:00
lethosor 4158267edc Ensure that docs/_auto/ exists 2018-04-02 14:14:03 -04:00
lethosor 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
lethosor 4feab67a93 Fix Python 2 compatibility
Ref #972
2016-10-23 18:28:41 -04:00
PeridexisErrant 951d293050 Add, use, and require auto docs for all keybindings 2016-10-20 18:33:31 +11:00
lethosor b211177a27 Fix version in docs for non-stable releases 2016-08-09 10:07:22 -04:00
lethosor cfaba3ec71 Update various references to scripts/ and mention old git issues in Compile.rst 2016-06-29 19:38:15 -04:00
lethosor 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
PeridexisErrant 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
PeridexisErrant c09b4f6b47 Tweak developer docs 2016-04-11 09:30:05 +10:00
PeridexisErrant 99b93ecd11 Move index back to root 2015-11-07 19:42:18 -05:00
lethosor f7a768f349 Update conf.py 2015-11-07 18:46:26 -05:00
lethosor e176c3ea05 Merge remote-tracking branch 'PeridexisErrant/docs-again' into develop 2015-11-07 15:50:11 -05:00
PeridexisErrant 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
PeridexisErrant 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
lethosor 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
PeridexisErrant 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
PeridexisErrant 6df0e26b05 Require 3rdparty docs to be in script source files 2015-11-02 09:32:50 +11:00
PeridexisErrant 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
expwnent cc752a582e Initial CMake version of Sphinx stuff. 2015-09-24 02:09:23 -04:00
PeridexisErrant 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
PeridexisErrant eb5286dd86 Misc changes for better structure 2015-09-22 18:42:15 +10:00
PeridexisErrant 336f8ee611 Name index.rst -> README.rst for Github integration 2015-09-22 18:26:56 +10:00
PeridexisErrant 4a8bf96bd3 Standard basic sphinx setup 2015-09-22 17:42:15 +10:00