698c467f6a
add quickstart help
2023-01-14 23:56:30 -08:00
e952957f91
move dev docs into dev dir
2022-11-30 04:01:32 -08:00
64ce2559fd
move "about" docs into subdir
2022-11-30 03:46:21 -08:00
7acec133ba
organize tags by group, add more info about tools
2022-08-15 23:14:50 -07:00
2fd6d528ce
move support docs to the intro page
...
but leave an orphan link to the new section in case external links still
point to the old page
2022-07-22 14:37:47 -07:00
bd58158126
get rid of tool TOC, use genindex
...
also add a stub role for dfhack-tag
2022-07-22 10:15:03 -07:00
301c8e93a1
move builtin docs to individual files
2022-07-18 10:58:35 -07:00
8d99b7e6e1
prepare for plugin doc split
2022-07-10 20:19:09 -07:00
4ad8e7199a
Support builtin commands in helpdb ( #2241 )
...
* support builtin commands in helpdb, implement list API, document api
2022-07-10 20:17:52 -07:00
64aba7a8a3
Myk rendered help ( #2240 )
...
* implement help db
* add initial list of tags
* read tags fr help, read script short desc, filter
2022-07-10 20:14:21 -07:00
27d7c3acc6
Myk sample command help ( #2238 )
...
* add example tool documentation in proposed format
* refine Tools.rst
2022-07-10 20:14:20 -07:00
102f0437a4
Move support channels to a separate page and update
...
Removing freenode due to takeover, etc.
2021-06-15 00:03:24 -04:00
00cd52dca7
Add user guides section to main toctree
2020-10-01 22:17:53 -04:00
128050c684
Move installation docs to a separate document and expand
2020-07-18 03:16:52 -04:00
801961bf78
Move changelog, license, authors into main TOC tree
2020-07-11 23:55:02 -04:00
1043a4e49b
Update intro, fix bay12 link, shorten index, add quick links section
2020-07-11 23:50:51 -04:00
87fd32d330
Move general dev info to a separate doc (Dev-intro)
2020-07-08 22:52:20 -04:00
858e90e6c2
Move Scripts-removed.rst to Removed.rst and update a bit
2020-07-08 21:04:23 -04:00
85003a40c2
Split memory research into separate doc and expand
2020-07-08 01:03:58 -04:00
aff2944f28
Add "scripts-" prefix to generated scripts subpage anchors
2020-07-08 01:01:34 -04:00
512f425c65
Move Contributing.rst to docs/, add GitHub-specific version in .github/
2020-07-07 23:49:28 -04:00
ce3cc24228
Split docs on documentation into a separate file and reorganize/expand a bit
2020-06-24 00:12:08 -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
98e1842427
List removed scripts to silence docs-related build failure
2017-12-23 21:15:16 -05:00
4c3515cc6b
Update NEWS.rst, add NEWS-dev.rst for prerelease changes
2016-12-14 12:59:55 -05:00
e6d2f4ea2e
Move Contributing.rst for Github banner link
2016-06-15 18:28:54 +10:00
99b93ecd11
Move index back to root
2015-11-07 19:42:18 -05: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
193e71793a
Fix compile, intro, scripts
...
- script-syntax.py now exits with 1 instead of silently catching the
error if lua or ruby are missing
- index paths are absolute (from the repo root)
- less strong suggestion for third-party packs
- re-added lua-example and test-perlin doc
- corrected and clarified Compile some more
2015-11-06 16:58:58 +11:00
3cc0b34d73
Clean up other docs to match
...
Some deduplication in Scripts and Plugins, links in NEWS, add content
and link to files in index.
2015-11-06 10:15:21 +11:00
5efea525e0
Split GitHub README from Sphinx index
...
The root of the documentation tree has a different function to the short
readme we want to display on GitHub, which now links to the main docs
(or Bay12 thread, or IRC). It also renders properly on GitHub, and can
use live-updating status badges because we don't expect it to work
offline.
2015-10-28 10:06:28 +11:00
Myk Taylor
lethosor
PeridexisErrant