Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation how to map directories #160

Merged
merged 1 commit into from
Feb 10, 2014

Conversation

@@ -142,6 +142,40 @@ Besides ``mappings``, the ``name``, ``sourceDirectory`` and ``target`` configura

**Note: The Universal plugin will make anything in a bin/ directory executable. This is to work around issues with JVM and file system manipulations.**

Mapping Examples
----------------
SBT provides and IO and .. Path: http://www.scala-sbt.org/0.13.1/docs/Detailed-Topics/Paths.html API, which
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/and/an/

.. ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OH, .. is the link syntax noise from sphinx. Right.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep ;) is markdown an option? Would be more readable on github too.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not if we use sphinx. Right now all the "verison-specific" website hooks we've created are sphinx-specific, if we want to copy that out of the sbt build itself. Otherwise, Markdown would be nice :)

@jsuereth
Copy link
Member

jsuereth commented Feb 9, 2014

The latest setup was a bit o' work if I recall correctly. If you want to tackle it, great. Otherwise I'm find with having "latest" on there always for now. Until we have a bit more solidified docs in general, I'm not sure the "old" ones are as helpful as, e.g. Akka's or Sbt's. Definitely needed before a 1.0, but right now things are still abit fluid.

@ivanfrain
Copy link
Contributor

@muuki88 Thanks for the documentation I'll test this as soon as possible.

@jsuereth
Copy link
Member

K, merging. With the next release, we should push docs as well. Maybe I'll add doc push to the release script....

jsuereth added a commit that referenced this pull request Feb 10, 2014
Adding documentation how to map directories
@jsuereth jsuereth merged commit 11978c7 into master Feb 10, 2014
@jsuereth jsuereth deleted the wip/directory-mappings-docs branch February 10, 2014 13:59
@muuki88
Copy link
Contributor Author

muuki88 commented Feb 10, 2014

That would be awesome. It should be easy to extend the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants