From f11ce9fda1c555d7e00e800614b34a24ed449c48 Mon Sep 17 00:00:00 2001 From: Csongor Somogyi Date: Tue, 15 Apr 2014 14:37:12 +0200 Subject: [PATCH] Updates in the Building Akka documentation page in accordance with the discussion with @bantonsson --- akka-docs/rst/dev/building-akka.rst | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/akka-docs/rst/dev/building-akka.rst b/akka-docs/rst/dev/building-akka.rst index 100476fc0f..8a732821be 100644 --- a/akka-docs/rst/dev/building-akka.rst +++ b/akka-docs/rst/dev/building-akka.rst @@ -103,12 +103,6 @@ to use from an sbt project) use the ``publish-local`` command:: sbt publish-local -.. note:: - - Akka generates class diagrams for the API documentation using ScalaDoc. This needs the ``dot`` command from - the Graphviz software package to be installed to avoid errors. You can disable the diagram generation by - adding the flag ``-Dakka.scaladoc.diagrams=false`` - sbt Interactive Mode -------------------- @@ -154,9 +148,8 @@ dependencies. Scaladoc Dependencies ===================== -The Scaladoc may generate Content (Type) Hierarchy diagrams. For this, you may -be required to download and install Graphviz (http://www.graphviz.org/). -The installed toolset has to be added to the PATH. - -Without Graphviz, the project will be completely built but with error messages -regarding the absence of the diagram tool cumulated at the end. +Akka generates class diagrams for the API documentation using ScalaDoc. This +needs the ``dot`` command from the Graphviz software package to be installed to +avoid errors. You can disable the diagram generation by adding the flag +``-Dakka.scaladoc.diagrams=false``. After installing Graphviz, make sure you add +the toolset to the PATH (definitely on Windows).