Commit Graph

218 Commits (5278856b3740f2b58a2d24c8a88a0d6e1e71d7da)

Author SHA1 Message Date
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 f25694d745 Only have one file named Readme 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 e7cf96d12e Format LICENSE - minimal content changes
No changes whatsoever are made to the licenses.  Formatting is
consistent.  Comments are cleaned up a little.  Some quotation marks are
consistent.  Added link target and links.
2015-09-26 12:28:06 +10:00
PeridexisErrant 2c2406727f More consistent formatting
Eg use of monospaced font, line length, internal links, added xml SYNTAX
to root table of contents.
2015-09-26 12:28:05 +10:00
PeridexisErrant 0307b0830f Plugins internal links, more formatting 2015-09-26 12:28:04 +10:00
PeridexisErrant a10c777f8f Add basic section on documentation standards
I expect this to expand once we get autodoc up and running.
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
expwnent cc752a582e Initial CMake version of Sphinx stuff. 2015-09-24 02:09:23 -04:00
PeridexisErrant ce09c8e099 NEWS markup for titles; changelog entries linkable
Some very light markup is all that's needed.  The underline with ====
makes each version into a linkable title and allows a table of contents
to be generated, while the `::` and blank line denotes that the rest is
a literal block.
I also shortened some very long lines, for readability.
2015-09-23 15:44:00 +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 5ba656bf79 Include changelog and licenses in generated docs
We may want to use .rst formatting for these eventually, and maybe move
the NEWS file to docs/News.rst and docs/History.rst - but for now
including the raw text works well enough.
2015-09-23 11:03:26 +10:00
PeridexisErrant 9d1baac6a0 Note issue with multidimensional arrays in lua
Closes #597.  Also remove old TODO in readme.
2015-09-23 10:38:46 +10:00
PeridexisErrant 8dc0e1a66e Clean up in dev-oriented docs 2015-09-23 00:06:56 +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
PeridexisErrant eb5286dd86 Misc changes for better structure 2015-09-22 18:42:15 +10:00
PeridexisErrant a5d1211fea Moved documentation to docs directory 2015-09-22 18:15:07 +10:00