Commit Graph

328 Commits

Author SHA1 Message Date
Mark Harrah 259bb192cf Docs: use programmatic version in global base directory 2013-10-29 13:21:04 -04:00
Cody Allen a292fd1378 Add SBT version to example path for credentials file
As of sbt 0.13, the credentials won't be found if they aren't within a version directory.
2013-10-29 11:54:48 -04:00
Mark Harrah 1030902207 Changes for 0.13.1-M1 2013-10-28 08:44:23 -04:00
Ches Martin a93767961c Docs: fix taskKey usage in Custom Settings example
Following commentary on 126f41c0ac
2013-10-22 09:29:35 -04:00
Joachim Hofer 76965895d0 updated links for my plugins that moved to the sbt org on github, added testng plugin 2013-10-20 17:38:31 -04:00
Travis f7cd647a2f Filter test options are backwards
The itFilter, defined as integration tests are configured to be run under task 'test' where I think you meant to hav then run under 'fun:test' and vise versa for the unitFilter.
2013-10-18 17:04:40 -04:00
Mark Harrah 9dcb8727d8 New method `toTask` on `Initialize[InputTask[T]]` to apply the full input and get a plain task out. 2013-10-18 16:49:34 -04:00
Mark Harrah d6ca66d406 Docs: sitemap generator, basic robots.txt. Fixes #916. 2013-10-17 15:00:48 -04:00
Mark Harrah 715a5655ef Deprecate some methods replaced by PathFinder.pair 2013-10-17 15:00:48 -04:00
Mark Harrah 9a85396d4f Include link to source on GitHub at bottom of the page. Fixes #921. 2013-10-16 19:26:25 -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
Michael Schmitz a7a5835c6c Update home.rst
It took me a while to find where the documentation was in the GitHub repository.  Maybe pages could link back to their source?
2013-10-15 15:18:23 -04:00
Mark Harrah 8bc0e5ab26 Docs: howto pages on classpaths and default paths 2013-10-14 19:59:32 -04:00
Mark Harrah 97e5ac8ec1 Read https+ftp proxy environment variables into system properties. Fixes #886. 2013-10-08 18:41:13 -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 f8a1d2ca7b Docs: add section on built-in parsers to Parsing-Input 2013-09-30 09:03:39 -04:00
Paolo G. Giarrusso c8638c405c Add aemoncannon/ensime-sbt-cmd
Note: I'm just a user of this plugin.
2013-09-27 06:41:37 -04:00
Eugene Yokota 1f77751888 Docs: Remove sbt-inspectr. Add Library dependency plugins section with sbt-updates. 2013-09-27 06:41:15 -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
Jacek Laskowski d9a12333c5 Update interactive.rst
Remove space as content may not start or end with whitespace http://sphinx-doc.org/rest.html#rst-primer
2013-09-26 08:18:33 -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 558029eee8 Docs: update Direct Usage section of Forking page. Closes #881. 2013-09-22 13:46:34 -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
Mikael Vallerie eb884eacd1 SBT Scage Plugin added 2013-09-09 08:41:40 -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
Josh Suereth d469ecdd5e Add documentation for how to publish to bintray and link packages online. 2013-08-29 11:45:23 -04:00
Mark Harrah 0c9c0fbfd8 Docs: fix problem with title being hidden 2013-08-27 10:36:22 -04:00
Mark Harrah a890f9b52d Docs: Add scaladoc/javadoc howto 2013-08-27 10:36:22 -04:00
Mark Harrah 72d2cf06b7 Docs: remove stray line in Howto/scala 2013-08-27 10:36:22 -04:00
Mark Harrah c500df66d5 Docs: Add cleanupCommands to howto 2013-08-27 10:36:22 -04:00
Mark Harrah f725dd6c65 Docs: pass build values to sphinx/conf.py via environment variables to reduce duplication. 2013-08-27 10:36:22 -04:00
Eugene Platonov 805efa9e01 add sbt-about-plugins
add sbt-about-plugins
2013-08-26 08:10:33 -04:00
Mark Harrah de771318da macros only require scala-reflect, not scala-compiler 2013-08-24 12:30:39 -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 88200480ee Docs: typo in faq 2013-08-16 14:21:44 -04:00
Mark Harrah 6c3570a133 Docs: fix |release| subsitution 2013-08-16 14:21:44 -04:00
Mark Harrah 8fd8c5fe94 Docs: version reorganization again in conf.py 2013-08-08 21:24:18 -04:00
Mark Harrah 5f2b5d4ad4 Docs: fix node constructed by code_literal role 2013-08-08 21:24:17 -04:00
Mark Harrah a09075c98c Docs: Fix tasklevel section in the logging howto. Ref #843 2013-08-08 21:24:17 -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 6d981e4c5b Docs: add sublit role that processes inline formatting, make default codeliteral role do no additional processing.
This was necessary because too many `` uses had * or | in them.
2013-08-07 18:24:19 -04:00
Mark Harrah 89d15ed1f9 Use repo.scala-sbt.org everywhere to be more independent of hosting details. 2013-08-07 18:24:19 -04:00
Mark Harrah f8e66fe89c Docs: remove remnants of static site 2013-08-07 18:24:19 -04:00
Mark Harrah 6488721378 Docs: note that JLine now looks at .inputrc 2013-08-06 13:59: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 f29b37e9d3 Docs: deterministic ordering of howto index 2013-07-29 07:27:17 -04:00
Mark Harrah 656506a7a7 Use actual release version in the site search base. Fixes #829. 2013-07-26 19:41:41 -04:00
Lloyd Meta 7ef27f7c57 Modify wording to be a bit more clear 2013-07-21 23:15:08 +09:00
Lloyd Meta 44d8a7de71 Update PGP signing plugin details in the summary
Since the recommended plugin is sbt-pgp, it was a little confusing to reach
the bottom of the [Deploying to Sonatype](http://www.scala-sbt.org/release/docs/Community/Using-Sonatype.html#summary) guide and
see references to the `xsbt-gpg-plugin` whereas the [top of the page](http://www.scala-sbt.org/release/docs/Community/Using-Sonatype.html#first-pgp-signatures) talks about using sbt-pgp.
2013-07-21 23:07:35 +09:00
Mark Harrah fda6b33c8b Docs: use 0.13.0 on Launcher page 2013-07-17 16:47:41 -04:00
Mark Harrah 3caed0bba8 Docs: consoleProject and .eval 2013-07-17 14:58:53 -04:00
Mark Harrah 3d11d50ffa Docs: update for test setup/cleanup when forking 2013-07-17 14:58:53 -04:00
Mark Harrah a0fdb3885d 0.13.1-SNAPSHOT to be able to use 0.13 plugins without changes 2013-07-17 14:58:53 -04:00
Mark Harrah 914afb1ca4 Docs: Use more lazy vals on Tasks.
The plain vals were technically correct, but new users don't
necessarily understand Scala initialization order.
2013-07-15 07:36:54 -04:00
David Harcombe a05c623495 Update Community-Plugins.rst
Add sbt-multi-publish
2013-07-12 15:27:25 -04:00
Mark Harrah f9a82b8eb6 Docs: better version handling/separation in conf.py 2013-07-12 15:11:50 -04:00
Mark Harrah 3f51a53d49 Docs: clean up organizations and links 2013-07-12 09:16:50 -04:00
Mark Harrah d8b3118ba4 Revert packaging='pom' behavior change introduced in c5823ad1e7. Fixes #810. Ref #636. 2013-07-11 18:49:30 -04:00
Mark Harrah 3cd0488bb1 Docs: fix versions in links on Setup page 2013-07-10 18:15:30 -04:00
Mark Harrah 9f75019dae Docs: note change in return type of test execution 2013-07-08 18:42:00 -04:00
Mark Harrah f4305023a7 Docs: more compatibility notes 2013-07-03 17:15:26 -04:00
Marko Elezovic ebb6b2cf70 Whitespace OCD 2013-07-02 08:21:32 -04:00
Mark Harrah 91e646f436 Docs: note JLine/Ansi changes 2013-07-02 08:21:23 -04:00
Mark Harrah b8ff4ca3d5 conscript launchconfigs for 0.13.0-SNAPSHOT 2013-06-28 12:12:58 -04:00
Mark Harrah 1377840cdf Make GitHub contributors and members pages primary means of credit to avoid staleness 2013-06-28 00:01:19 -04:00
Mark Harrah 77d8c0b022 Docs: plugins repository not needed since it is added by default now 2013-06-28 00:01:19 -04:00
Mark Harrah 48a6d117cd Docs: fixes and reworked Setup page 2013-06-28 00:01:19 -04:00
Mark Harrah 913236fc8e Docs: fix typo 2013-06-27 14:12:43 -04:00
Grzegorz Kossakowski 65c1b122df Add documentation for api debugging feature.
Include a new section in `Understanding-incremental-compilation`
document which explains in detail how to turn on and use the
new api debugging feature.
2013-06-26 16:50:05 -07:00
Grzegorz Kossakowski 64b7590463 Document changes to dependency trackin in incremental compiler.
Mention distinction between dependencies through inheritance and member
reference. Add an example which demonstrates the difference a little
bit more concretely by using some simple Scala source code.
2013-06-26 11:13:16 -07:00
Grzegorz Kossakowski 248a5ccb15 Add `sbt.extraClasspath` to command line reference. 2013-06-26 10:17:49 -07:00
Grzegorz Kossakowski 59343313f1 Convert table in cmd line reference to a real rST table.
Previous table was mix of reStructuredText and html produced by
automatic conversion tool. The result was rather unreadable and very
hard to edit.

I converted the table to native reStructuredText's table.
2013-06-25 23:46:15 -07:00
Grzegorz Kossakowski 59cea58892 Mention api debugging improvements in change summary for 0.13
Mention both #677 and #793 which introduced all functionality needed
for api debugging.
2013-06-25 17:08:09 -07:00
Mark Harrah 4c515d3aa0 Docs: note about Scala version override being dropped 2013-06-24 18:42:15 -04:00
Mark Harrah ce1c8b0ebc Better auto project ID handling. Ref #776.
* Consolidate project ID validation and normalization into Project methods
* Provide an earlier and more detailed error message when the directory
  name can't be used for the project ID
2013-06-23 19:57:30 -04:00
Mark Harrah f5febfae0e Docs: note fix for class loader cache 2013-06-20 14:28:05 -04:00
Mark Harrah 2f9d68e869 Require projects to have unique target directories.
Configuring projects so that target directories overlap is usually
unintentional and the error message that results is usually unrelated
to the cause.
2013-06-18 18:43:50 -04:00
Mark Harrah 2ebf9f1a4a Docs: fixes, updates, reorganization 2013-06-16 10:21:21 -04:00
Mark Harrah 6cee9d4aa4 0.13.0-Beta2 2013-06-05 23:57:21 -04:00
Josh Suereth 96f7a0dc3c Add google analytics tracking to sbt documentation, so we can see which topics people are most interested in and better organize things. 2013-06-04 11:29:32 -04:00
Mark Harrah c3bfbad869 Docs: fix broken link on nightly builds 2013-06-04 11:25:36 -04:00
Mark Harrah 26876571d3 Docs: release in docs should be -Beta1 2013-06-03 08:51:53 -04:00
Damien Lecan e2cacf2b6a Fix typo error 2013-06-03 08:17:43 -04:00
Nicolas Rémond 1171782f42 The last release of xsbt-gpg-plugin is 0.6, not 0.5 2013-06-03 08:17:32 -04:00
Mark Harrah 664ded9f28 Docs: small fix to UpdateReport 2013-06-01 10:56:30 -04:00
Mark Harrah 19d75ae2f9 preparation for 0.13.0-Beta1 2013-06-01 10:56:30 -04:00
Mark Harrah db3e738802 update changes for 0.12.4-RC1 2013-05-31 11:14:24 -04:00
Mark Harrah bd65895b9e Use the recommended sbt.log.format property instead of noformat in the docs 2013-05-27 19:12:39 -04:00
Mark Harrah ddd284352a Docs: note that source generators can generate Scala and Java sources together. 2013-05-10 16:29:02 -04:00
Mark Harrah b3bf74d272 Docs: cleanup related to generating sources+resources 2013-05-10 16:27:13 -04:00
Mark Harrah 772d1aebf6 Docs: fix typos on Input-Tasks page 2013-05-08 12:56:50 -04:00
Mark Harrah 8d461953d4 snapshot version 2013-05-06 08:28:34 -04:00
Mark Harrah d94bea695d update change summary for 0.13.0-M2 2013-05-05 23:13:42 -04:00
Mark Harrah 5b90eee971 0.13.0-M2 2013-05-05 22:34:59 -04:00
Li Haoyi c3345313cc Update Using-Sonatype.rst
according to this

http://www.scala-sbt.org/sbt-pgp/usage.html#publishing_artifacts

"The PGP plugin NO LONGER wires into the default publish and publish-local tasks of sbt. If you want to published signed artifacts, you must use the new publish-signed and publish-local-signed tasks."

This bit me when i tried to do this today, should update the docs to refer to the proper command `publish-signed` so the next guy who tries this doesn't get bitten.
2013-04-25 08:46:40 -04:00
Mark Harrah 7689343ba0 Docs: correct custom Ivy configuration faq section 2013-04-15 18:18:52 -04:00
Ian Forsey 0e7d212604 Add xsbt-coveralls-plugin to list of code coverage plugins 2013-04-15 11:12:23 -04:00
Mark Harrah d6b548596b fix scripted tests 2013-04-09 20:13:06 -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 4dde1468ad Docs: fix formatting in LocalScala from initial conversion to rST 2013-04-09 13:54:45 -04:00
Robin Green d95263f582 Docs: Fixed name of http_proxy env var 2013-04-08 09:22:24 -04:00
Mark Harrah 322a49faba Make autoCompilerPlugins support compiler plugins defined in a internal dependency
requires the compiler plugin project to define exportJars := true
2013-04-03 12:44:35 -04:00
Eugene Platonov 8ce252d1b1 fix some code snippets for BuildLoader examples 2013-04-01 12:42:26 -04:00
Mark Harrah bd2a8e3afb Docs: note about postfix precedence on Tasks page 2013-04-01 11:39:02 -04:00
Philipp Dörfler 2d00fbc92b sbt-fx was renamed to sbt-fxml
There is a similarily named plugin "sbt-javafx" which is not listed here and which I discovered afterwards
2013-03-28 21:30:28 -04:00
Philipp Dörfler 7c67ad28be Added link to sbt-fx 2013-03-28 16:08:56 -04:00
Mark Harrah d6ef9b0154 Docs: fix ScopeFilter API doc links 2013-03-28 16:08:23 -04:00
Mark Harrah 24fc00ddd5 Docs: escape the - in -b, since it gets interpreted as an option list otherwise 2013-03-28 16:08:23 -04:00
Mark Harrah 5f648d449a Docs: list multi-scope selection on changes page 2013-03-27 09:17:54 -04:00
Mark Harrah 8b68e0f09e Docs: add section on getting values from multiple scopes 2013-03-27 09:17:53 -04:00
Mark Harrah 7ad678f4a4 Docs: cleaned up Tasks pages: clarified its purpose and reorganized 2013-03-27 09:17:53 -04:00
Mark Harrah 6113f55101 Docs: present the TaskInputs page as motivation and for deeper understanding 2013-03-27 09:17:53 -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 2a3af7fdca Docs: disable publishing for a project by overriding publishLocal to do nothing instead of deliver 2013-03-27 09:17:53 -04:00
Mark Harrah ebd24e95df back to a snapshot version 2013-03-18 11:47:45 -04:00
Mark Harrah 1ea9c5cf9b 0.13.0-M1 2013-03-18 10:28:02 -04:00
Alois Cochard 9aa575742b Rename xsbt-fmpp to sbt-fmpp url and add sbt-scalabuff 2013-03-15 10:23:31 -04:00
Mark Harrah 1f52917dc5 Docs: typo on Changes page 2013-03-15 10:15:16 -04:00
Mark Harrah 3e3d7949eb Docs: latest change summary, including 0.12.3-RC2 2013-03-14 16:17:12 -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 5b80e8c941 use .evaluated instead of .value for InputTasks 2013-03-08 14:23:31 -05:00
Mark Harrah 114cf2dbd8 expand input task documentation. ref #407 2013-03-08 14:23:31 -05:00
Mark Harrah f61f87632c 0.12.3 changes 2013-03-06 09:23:48 -05:00
Mark Harrah ada663106d Further Scala handling refinements. fixes #690.
* No longer override the Scala version to force it to be scalaVersion.  Custom configurations might use an independent version.
* Only substitute the jars from scalaHome when the major.minor versions line up for the substituted artifact
* Allow the Scala version to use for dependency resolution to be specified when using ++ to change Scala home: ++ version=/path/to/scala/home
2013-03-05 17:22:21 -05:00
Mark Harrah 5c7f0fdc60 Docs: change summary: class file restoration after unsuccessful compilation 2013-03-04 08:02:24 -05: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 af24fa5553 Docs: fix underline length 2013-03-04 07:31:40 -05:00
Eric D. Reichert c78fba8825 Added the tl-os-sbt-plugins to the Community-Plugins documentation. 2013-03-04 07:29:21 -05:00
Mark Harrah 85b6ff2c5c Docs: export command added to changes 2013-02-28 17:59:39 -05:00
Mark Harrah daf300f4a9 Add environment variable change to 0.13.0 summary 2013-02-28 17:59:38 -05:00
Juan Manuel Caicedo Carvajal 0ca2ae5843 Updated the host name used for publishing artifacts to the community repository. 2013-02-28 08:30:45 -05:00
Mark Harrah 9492a6b433 Docs: fix note about built-in support for test frameworks 2013-02-25 09:24:04 -05:00
Mark Harrah 98b40b7885 Revert "outputStrategy does not apply to test tasks"
This reverts commit 6c6d86d5ce.

It does now.
2013-02-21 20:44:26 -05:00
Jan Niehusmann f9059849df Fix link to sbt-git plugin
The old url https://github.com/sbt/sbt-git-plugin resulted in an 404 error. Changed to https://github.com/sbt/sbt-git which seems to be the correct url for that plugin.
2013-02-19 09:30:38 -05:00
Adam Warski 9d4b604513 Updating the address of the xsbt-proguard-plugin 2013-02-19 08:54:45 -05:00
Mark Harrah b152a836c5 Docs: syntax fixes 2013-02-13 08:16:25 -05:00
Matthew Farwell 6c6d86d5ce outputStrategy does not apply to test tasks 2013-02-13 07:19:27 -05:00
Mark Harrah 4417e12602 Docs: remove spurious dollar sign in manual unix script 2013-02-13 07:19:27 -05:00
Orr Sella aa93f43381 Added sbt-stats to community plugins 2013-02-05 21:07:40 -05:00
Orr Sella 60fb5dcfd8 Added sbt-sublime to community plugins 2013-02-05 21:07:37 -05:00
Eugene Yokota 125727ba83 support binary version in launcher 2013-01-29 16:55:13 -05:00
Mark Harrah 76a02c463f Temporarily use a Scala home with '++ /path/to/scala/home' 2013-01-28 17:14:53 -05:00
Mark Harrah 0ff37a5fdd Docs: no need to copy sources, which aren't used anywhere on the site 2013-01-16 10:26:56 -05:00
beolnix 1aa6215191 fix documentation bug: the main class should be "sbt.ScriptMain" in the paragraph about the scalas 2013-01-15 08:24:51 -05:00
Matthew Farwell 53599cc24e Added scalastyle to community plugins 2013-01-15 08:24:39 -05:00