raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

Updates in the Building Akka documentation page in

Browse source 
accordance with the discussion with @bantonsson
This commit is contained in:
Csongor Somogyi 2014-04-15 14:37:12 +02:00
parent 9230f9710f
commit f11ce9fda1
1 changed files with 5 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

17
akka-docs/rst/dev/building-akka.rst
View file

@ -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).