Commit Graph

14 Commits (428a0a4cfe8fa77f39a9db7045b9b7d737129be3)

Author SHA1 Message Date
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