Commit Graph

27 Commits (b24cbe6f84c8a7040f94d35637c3b99556c0274b)

Author SHA1 Message Date
PeridexisErrant 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
PeridexisErrant 6df0e26b05 Require 3rdparty docs to be in script source files 2015-11-02 09:32:50 +11:00
PeridexisErrant 69090e114c Explain script type at top of listing
Using an `about.txt` file in each directory.  This is nice because it
keeps the purpose notes in the actual script directories.
2015-10-24 17:41:21 +11:00
PeridexisErrant 54f3c6a138 Updated docs linter for scripts
Also made scripts toctree more explicit
2015-10-24 17:00:54 +11:00
PeridexisErrant ddae19ad8b Move base scripts 2015-10-24 15:10:15 +11:00
PeridexisErrant abb882618b Move modtools docs 2015-10-24 10:57:04 +11:00
PeridexisErrant f8d965b8ea Migrate fix, gui script docs; add link shortcuts
Because it's a lot easier to link to bug reports this way.

The migration is mostly just a copy-paste job, but I'm using keybinding
styles where appropriate too.
2015-10-24 01:37:39 +11:00
PeridexisErrant 5e02e00e2c Autogen script links, table of contents, and demo!
Automatically generating the link target for each script saves a lot of
time and potential for errors.

Each kind-of-script page now includes a link target for that page, and
also a table of contents.

In-script markers to delimit text for Sphinx extraction now use native
docstring markers from Ruby, which is a lot more elegant in .rb scripts
- and robust, as long as the fisrt docstring is valid .rst!
2015-10-24 00:33:35 +11:00
PeridexisErrant d98ee535a1 Much improved script docs generator
Creates a single file for each kind of script (base, gui, fix...).  This
includes and correctly sorts content from any .lua or .rb file under the
scripts directory.  It's more robust and more readable than the old
style, and doesn't write anything in the submodules.  User-added scripts
will be seamlessly added, if they have a docs section and Sphinx is run.
2015-10-23 22:25:04 +11:00
PeridexisErrant a305c40bb2 Finish formatting old NEWS 2015-10-20 14:08:34 +11:00
PeridexisErrant fb2fdd0e89 Format more of the NEWS file 2015-10-20 13:29:46 +11:00
PeridexisErrant 18d2bc6183 Format 0.40.24-r3 changelog
Including plenty of nice hyperlinks and a formatting which looks a lot
better in HTML (but still decent in raw text, too).
2015-10-19 14:59:35 +11:00
PeridexisErrant c5d6e693f8 Use command name only for internal hyperlinks
Because it's not actually that important to the user how a command is
implemented, and the docs should reflect that.  This also makes them
easier to write!
2015-10-19 14:16:19 +11:00
PeridexisErrant bd5eb82554 Get autodoc working properly.
With a complete index, only generate needed files, etc.
2015-10-19 13:57:33 +11:00
lethosor 3685ed5156 Fix typo (comfortable)
Closes #708
2015-10-07 16:43:02 -04:00
lethosor c11febf386 Document add-thought 2015-10-03 16:05:37 -04:00
expwnent c15b01a79a Autogenerate include-all.rst for scripts so that script documentation can be entirely encapsulated in lua files without updating anything else. 2015-09-27 02:45:11 -04:00
lethosor d6821e6d66 Clean up .travis.yml 2015-09-26 20:05:32 -04:00
PeridexisErrant e92d63d248 Final documentation changes
Squashes a couple of commits from the other branch onto the last one
here.
2015-09-26 16:50:02 +10:00
PeridexisErrant 2302698b22 Consolidate binpatch docs. Closes #546
Binpatches aren't used much at the moment, so this has two purposes:
collate information so it's easier to write them again, and remove it
from other sections where it's useless.

Note that if the standalone binpatch.exe is removed, the 'patching on
disk' section can be cleanly removed from 'Using a patch' by deleting
lines 44-47 & 61-90.
2015-09-26 12:28:09 +10:00
PeridexisErrant d57e84fc0f Document all missing plugins, update NEWS
Checked with a throwaway script, and added the missing entries.  NEWS
now has a comment on how to use the file, which is only visible in the
raw text version.  Added the documentation changes to NEWS.
2015-09-26 12:28:08 +10:00
PeridexisErrant 00a261cc81 More internal links and consistent formatting
Links everywhere, and formatting throughout Plugins.rst
2015-09-26 12:28:07 +10:00
PeridexisErrant 53d5d3b897 Add listing of 3rdparty scripts, in Scripts doc
This will automatically find any .rst documentation matching the
pattern, and include it.
2015-09-26 12:28:06 +10:00
PeridexisErrant 0307b0830f Plugins internal links, more formatting 2015-09-26 12:28:04 +10:00
PeridexisErrant 780a9f3677 Internal links and link targets, formatted tables
* Enabled internal links; a phrase in backticks is linked to the
corresponding link target and turns into the corresponding title.
* Linked all existing references in Scripts.rst
* Created corresponding link targets
* Fixed formatting of some tables of arguments.
2015-09-26 12:28:03 +10:00
PeridexisErrant 8661f5dc4f Add linter to check scripts are in readme, pass it
We knew a fair few were missing, but this was more than I expected.
2015-09-23 15:25:41 +10:00
PeridexisErrant 8141de869b Split readme into files for scripts, plugins, and base
The plugin docs are still a mess, but the base and scripts are now close
to manageable.
2015-09-22 23:30:22 +10:00