2012-12-10 10 views
10

Ich versuche, das Scaladoc in SBT zu konfigurieren, insbesondere den Titel, das Ausgabeverzeichnis und den Klassenpfad.SBT Scaladoc Konfiguration

gelang es mir, indem Sie die folgenden, den Titel zu definieren, um build.sbt:

scalacOptions in (Compile, doc) ++= Opts.doc.title("Scala-Tools") 

Ich kann nicht herausfinden, wie das doc Ausgabeverzeichnis zu ändern.

Ich kann auch nicht herausfinden, wie Gläser zu Classpath hinzufügen. Der Grund, warum ich den Klassenpfad bearbeiten möchte, ist, dass die Standard-Scala-Bibliothek nicht von scaladoc aufgenommen wird, wenn ich auf ihre Klassen referenziere, dh [[scala.Option]] führt zu einer Warnung "Es konnte kein Mitglied zum Verknüpfen gefunden werden für "scala.Option". "

Jede Hilfe, auch in Form eines Beispiels SBT-Konfiguration wäre willkommen!

Ich benutze Scala 2.10-RC3 und SBT 0.12.1.

Antwort

6

Die Scala-Bibliothek befindet sich auf dem Klassenpfad, andernfalls würde scaladoc mit einem Fehler ziemlich schnell ausbrechen. Die Warnung, die Sie sehen, bedeutet, dass scaladoc nicht weiß, wie man mit Option verlinkt. Dazu müssen Sie entweder die Option -external-urls oder die Option -doc-external-doc in 2.10.1 verwenden. Die Ausgabe von scaladoc -help für die kommende 2.10.1 zeigt:

-doc-external-doc:<external-doc> comma-separated list of classpath_entry_path#doc_URL pairs describing external dependencies. 
-external-urls:<externalUrl(s)> (deprecated) comma-separated list of package_names=doc_URL for external dependencies, where package names are ':'-separated 

Die Lösung bis 2.10.1 ist out ist -external-uris zu verwenden:

-external-urls:scala=http://www.scala-lang.org/archives/downloads/distrib/files/nightly/docs/library/ 
+0

Dank Mark! Bei Verwendung dieser Lösung erhalte ich jedoch einen Fehler: '[Fehler] Quelldatei 'http://www.scala-lang.org/archives/downloads/distrib/files/nightly/docs/library/' konnte nicht gefunden werden ' – user510159

+0

Wenn ich auch 'scaladoc -help' betrachte, kann ich nichts über das Ausgabeverzeichnis finden (der andere Teil meiner Frage). – user510159

+0

Sie sollten zeigen, wie Sie das weitergeben. Ich habe es vor dem Posten von der Kommandozeile aus versucht und es hat funktioniert. Die Fehlermeldung scheint zu implizieren, dass es als eine Quelldatei interpretiert wird. Wie beim Ändern des Ausgabeverzeichnisses ist es die Option "-d" in der Befehlszeile, aber sbt behandelt sie für Sie mit der Einstellung "docDirectory in Compile" (oder "in Test"). Warum möchten Sie das Ausgabeverzeichnis jedoch ändern? –