Commit Graph

43 Commits

Author SHA1 Message Date
Josh Suereth ea8c0b32a7 Update documentation for AutoPlugins.
* Add notes about AutoPlugins vs. RootPlugins in Plugins section
* Modify best practices section to recomend using AutoPlugins.
* Modify Using-Plugins section in getting started to denote
  auto plugins.
2014-03-10 09:45:25 -04:00
Josh Suereth 01bb7ce2fd Remove defaultSettings usage from the docs.
Given the addition/promotion of AutoPlugins, remove
the references to the previously necessary
Defaults.defaultSettings method.
2014-03-10 09:45:25 -04:00
Suzanne Hamilton 4ab8074753 Fix formatting of inline code samples which are pluralized 2014-02-06 08:49:44 -05:00
Jacek Laskowski 2caadceaf6 Small changes 2014-01-01 23:29:35 +01:00
William Benton 5df24e5eb2 Update documentation references to Ivy 2.3.0 2013-12-13 14:25:56 -06:00
drdamour 54075c750d resubmit of #983 2013-11-13 15:49:29 -05:00
Mark Harrah 7d10c7e103 Docs: correct substitution syntax when preceding character is symbol. Fixes #970. 2013-11-11 09:30:31 -05:00
Ches Martin a93767961c Docs: fix taskKey usage in Custom Settings example
Following commentary on 126f41c0ac
2013-10-22 09:29:35 -04:00
Mark Harrah 7b7e642393 Docs: minor fixes 2013-10-16 19:26:19 -04:00
Michael Schmitz 126f41c0ac Complete code example in Custom-Settings.rst
The original wording confused me.  I thought it meant that there was no point to my new keys unless I used them in a task.  But rather it meant that I needed to create keys for my task and then a task definition with the same key name.  I added the creation of the keys to the task implementation code example to clear this up in the future.
2013-10-15 15:19:48 -04:00
Jacek Laskowski 9f630542b8 Update Custom-Settings.rst
Add a link to Basic-Def.
2013-09-30 09:03:50 -04:00
Mark Harrah 28a4bb3642 Docs: Add and use custom 🔑 role that links to the val in sxr/sbt/Keys.scala. 2013-09-26 18:26:19 -04:00
Mark Harrah b2599c1bb1 Restore sxr support and fix links to sxr'd sources. Fixes #863. 2013-09-24 11:34:14 -04:00
Mark Harrah d1686d438c Docs: fix global plugins paths to include version in Getting-Started/Full-Def 2013-09-20 12:49:00 -04:00
Mark Harrah 0ff96da70e Docs: clean up Getting-Started/Basic-Def, including an example of defining a key. Fixes #862. 2013-09-18 10:27:19 -04:00
Mark Harrah 54996e9690 Docs: phase out mailing list as a support channel 2013-09-11 09:36:49 -04:00
Brian Smith ffc58d4160 Include instructions for backspace key under cygwin (mintty)
Added note about setting in mintty to force sending of ^H which is necessary for the scala console backspace to work when jline.UnixTerminal is set and stty erase is ^H.  Additional documentation for #562.
2013-09-06 21:49:48 -04:00
Bardur Arantsson 908a52b308 Docs: Remove leading $'s from scripts in Setup instructions 2013-09-05 13:31:08 -04:00
Mark Harrah d1c68295c0 Docs: removing remaining mentions of "~=" 2013-08-30 18:34:54 -04:00
Mark Harrah d0a8f40b99 Docs: last updates to getting started guide for 0.13.0 2013-08-23 01:58:07 -04:00
Mark Harrah 70a54b9848 initial refresh of getting started guide for 0.13: multiple projects and plugins
still todo: Custom-Settings, Full-Def
2013-08-07 18:24:19 -04:00
Mark Harrah c14179c358 Docs: custom role 'codeliteral' to allow substitutions in inline code
The built-in 'literal' role implements ``.  It tokenizes the
literal string to attempt some particular wrapping behavior.
This puts parts of the string in different spans, each with
class='pre' and the previous docs.css had a padding for that
class.  This led to excessive space within the literal string.

The custom role does no do this tokenization, but nested
inline parsing can result in multiple nodes, repeating the
problem.  So, the padding for class='pre' is dropped.  Ideally,
the sequence of nodes would simply be wrapped in an inline element
with class='pre' or some other proper solution that avoids having
multiple nodes.

To avoid wrapping in the middle of a literal, the 'pre' class
now has the style `white-space: pre;`.

The default role is now 'codeliteral' and the previous
uses of the built-in `` are converted to `.  Some incorrectly
converted code blocks were fixed in the process.

Finally, the Global-Settings page is updated with the new location
for the global sbt directory.  Due to the above changes, this could
be done without hardcoding the version.
2013-07-29 07:27:17 -04:00
Mark Harrah 3cd0488bb1 Docs: fix versions in links on Setup page 2013-07-10 18:15:30 -04:00
Mark Harrah 48a6d117cd Docs: fixes and reworked Setup page 2013-06-28 00:01:19 -04:00
Mark Harrah d3f8bdb837 Docs: move contents of dormant configurations page into Library-Management 2013-04-09 13:54:45 -04:00
Mark Harrah b051d1e2c3 docs: drop section in getting started on sharing settings
with vals allowed in .sbt files, it is not necessary to include it
2013-03-27 09:17:53 -04:00
Mark Harrah 27a630e0d0 Docs: more 0.13 cleanup
* Drop dependOn, dependsOn.  These are rarely the right method to call.
* Drop references to ~= in favor of just :=.
* Drop a .scala example where a .sbt example suffices.
2013-03-12 09:20:20 -04:00
Mark Harrah f5de32dc27 Docs: fix nightly build/Setup pages for 0.13.0-SNAPSHOT 2013-03-04 07:55:45 -05:00
Mark Harrah 4417e12602 Docs: remove spurious dollar sign in manual unix script 2013-02-13 07:19:27 -05:00
xuwei-k b5646946e4 ivy version 2.3.0-rc1 in documents 2012-12-31 09:23:23 -05:00
Mark Harrah 518bbc4077 Docs: more cleanup for 0.13 2012-12-06 19:11:07 -05:00
xuwei-k 4b17d12de0 xsbt-web-plugin moved 2012-12-02 03:19:29 -05:00
Mark Harrah 77a709df13 doc fixes 2012-12-02 03:17:20 -05:00
Mark Harrah 3bff14d77a taskKey,settingKey,inputKey macros to get name from the defining val 2012-12-02 03:17:20 -05:00
Mark Harrah 132e29415b Docs: initial pass for updated task syntax, vals in .sbt, camelCase 2012-11-19 22:14:12 -05:00
Mark Harrah dba160dd1d had to drop non-ascii unicode characters for latex for now 2012-11-08 22:40:23 -05:00
Mark Harrah 42c04c4d57 Docs: remove Yum and Apt sections. These repos follow Typesafe stack releases, not sbt releases. 2012-10-11 10:04:33 -04:00
Mark Harrah 62ce0495a3 Docs: Getting-Started/Setup fixes 2012-10-05 22:57:12 -04:00
Josh Suereth 5f907d55aa Update src/sphinx/Getting-Started/Setup.rst
Modify getting started guide download page to:

* have correct links
* highlight native packages, and community packages
* include direct downloads of 0.12.1 bundles.
2012-10-05 22:46:44 -04:00
Mark Harrah 0bf22bb0e6 docs: fix Apt section of Setup 2012-10-01 14:31:12 -04:00
Mark Harrah 3acc17d259 doc updates, conversions, howto extension, theme from akka 2012-09-30 20:36:38 -04:00
Mark Harrah b98e12e9dd first step in md -> rst conversion 2012-09-30 20:36:38 -04:00
Mark Harrah 9b9a09f9af Import src/sphinx/ from wiki markdown, needs conversion to rst. 2012-09-30 20:36:38 -04:00