Skip to content
Browse files

Updated documentation buildout and migrated default build version to …

…2.8.1, removing 2.8.1rc4
  • Loading branch information...
1 parent 320ba39 commit 766a3bb1e9bcf4ae7a7371018431ce1d9bab9046 @bwmcadams bwmcadams committed
Showing with 22 additions and 17 deletions.
  1. +10 −10 buildDocs.sh
  2. +8 −4 doc_index.html
  3. +1 −1 project/build.properties
  4. +3 −2 project/build/CasbahProject.scala
View
20 buildDocs.sh
@@ -6,19 +6,19 @@ mkdir -p docs/casbah-core
mkdir -p docs/casbah-gridfs
mkdir -p docs/casbah-query
-sbt "update" "clean" "doc"
+sbt "+update" "+clean" "+doc"
-cp -R casbah-commons/target/scala_2.8.0/classes.sxr docs/casbah-commons/sxr
-cp -R casbah-commons/target/scala_2.8.0/doc/main/api docs/casbah-commons/api
-cp -R casbah-core/target/scala_2.8.0/classes.sxr docs/casbah-core/sxr
-cp -R casbah-core/target/scala_2.8.0/doc/main/api docs/casbah-core/api
-cp -R casbah-gridfs/target/scala_2.8.0/classes.sxr docs/casbah-gridfs/sxr
-cp -R casbah-gridfs/target/scala_2.8.0/doc/main/api docs/casbah-gridfs/api
-cp -R casbah-query/target/scala_2.8.0/classes.sxr docs/casbah-query/sxr
-cp -R casbah-query/target/scala_2.8.0/doc/main/api docs/casbah-query/api
+cp -R casbah-commons/target/scala_2.8.1/classes.sxr docs/casbah-commons/sxr
+cp -R casbah-commons/target/scala_2.8.1/doc/main/api docs/casbah-commons/api
+cp -R casbah-core/target/scala_2.8.1/classes.sxr docs/casbah-core/sxr
+cp -R casbah-core/target/scala_2.8.1/doc/main/api docs/casbah-core/api
+cp -R casbah-gridfs/target/scala_2.8.1/classes.sxr docs/casbah-gridfs/sxr
+cp -R casbah-gridfs/target/scala_2.8.1/doc/main/api docs/casbah-gridfs/api
+cp -R casbah-query/target/scala_2.8.1/classes.sxr docs/casbah-query/sxr
+cp -R casbah-query/target/scala_2.8.1/doc/main/api docs/casbah-query/api
cp doc_index.html docs/index.html
cd docs
-perl -p -i -e 's#http://api.mongodb.org/scala/casbah/source.sxr/.*(casbah-.*)/src/main/scala#http://api.mongodb.org/scala/casbah/\1/sxr#gi' `find ./ -name \*.html`
+perl -p -i -e 's#a href="http://api.mongodb.org/scala/casbah-(.*)/casbah-(.*)/sxr/.*/casbah-\2/.*src/main/scala/(.*)"#a href="/scala/casbah/\1/casbah-\2/sxr/\3.scala.html"#gi' `find ./ -name \*.html`
View
12 doc_index.html
@@ -5,10 +5,14 @@
<body>
Casbah consists of several modules. Which documentation do you want?
<ul>
- <li><a href="casbah-commons/api/index.html">casbah-commons</a> Utilities to improve working with Scala and MongoDB together without dependencies on anything but the MongoDB Java Driver and ScalaJ-Collection. This includes Scala Collections 2.8 compatible wrappers for DBList and DBObject as well as type conversion facilities to simplify the use of Scala types with MongoDB (and register your own custom types)</li>
- <li><a href="casbah-query/api/index.html">casbah-query</a> The Query DSL; provides an internal Scala DSL for querying MongoDB using native, MongoDB syntax operators. This only depends upon Commons and can be used standalone without the rest of Casbah.</li>
- <li><a href="casbah-core/api/index.html">casbah-core</a> The wrappers for interacting directly with MongoDB providing more Scala-like interactions. It depends upon both Commons and Query as well as ScalaTime for use of JodaTime (which we prefer over JDK date but you are welcome to use JDK Dates).</li>
- <li><a href="casbah-gridfs/api/index.html">casbah-gridfs</a> This provides enhancement wrappers to GridFS including loan pattern support. It is dependent on Core (and by transitive property, Commons & Query as well) but is not included in Core - you must explicitly load if it you want to use GridFS.</li>
+ <li><a href="casbah-commons/api/index.html">casbah-commons</a><br> Utilities to improve working with Scala and MongoDB together without dependencies on anything but the MongoDB Java Driver and ScalaJ-Collection. This includes Scala Collections 2.8 compatible wrappers for DBList and DBObject as well as type conversion facilities to simplify the use of Scala types with MongoDB (and register your own custom types)</li>
+ <br>
+ <li><a href="casbah-query/api/index.html">casbah-query</a> <br>The Query DSL; provides an internal Scala DSL for querying MongoDB using native, MongoDB syntax operators. This only depends upon Commons and can be used standalone without the rest of Casbah.</li>
+ <br>
+ <li><a href="casbah-core/api/index.html">casbah-core</a> <br>The wrappers for interacting directly with MongoDB providing more Scala-like interactions. It depends upon both Commons and Query as well as ScalaTime for use of JodaTime (which we prefer over JDK date but you are welcome to use JDK Dates).</li>
+ <br>
+ <li><a href="casbah-gridfs/api/index.html">casbah-gridfs</a><br> This provides enhancement wrappers to GridFS including loan pattern support. It is dependent on Core (and by transitive property, Commons & Query as well) but is not included in Core - you must explicitly load if it you want to use GridFS.</li>
+ <br>
</ul>
</body>
View
2 project/build.properties
@@ -5,5 +5,5 @@ project.name=casbah
sbt.version=0.7.4
project.version=2.0b2
def.scala.version=2.7.7
-build.scala.versions=2.8.0 2.8.1.RC4
+build.scala.versions=2.8.1 2.8.0
project.initialize=false
View
5 project/build/CasbahProject.scala
@@ -38,8 +38,9 @@ class CasbahProject(info: ProjectInfo)
super.compileOptions ++ Seq(Unchecked, ExplainTypes, Deprecation)
override def documentOptions = Seq(
- CompoundDocOption("-doc-source-url", "http://api.mongodb.org/scala/casbah/source.sxr/"),
- CompoundDocOption("-d", mainScalaSourcePath.toString)
+ CompoundDocOption("-doc-source-url", "http://api.mongodb.org/scala/casbah-%s/casbah-%s/sxr/€{FILE_PATH}".format(projectVersion.value, projectName.value)),
+ CompoundDocOption("-doc-version", "v%s".format(projectVersion.value)),
+ CompoundDocOption("-doc-title", "Casbah %s".format(projectName.value))
)
// Testing Deps
val specs = "org.scala-tools.testing" % "specs_2.8.0" % "1.6.5" % "test->default"

0 comments on commit 766a3bb

Please sign in to comment.
Something went wrong with that request. Please try again.