文档指南

.. _reStructuredText:
.. _sphinx: http://sphinx.pocoo.org

Sphinx

For more details see The Sphinx Documentation <http://sphinx.pocoo.org/contents.html>_

reStructuredText

For more details see The reST Quickref <http://docutils.sourceforge.net/docs/user/rst/quickref.html>_

Section headings are very flexible in reST. We use the following convention in
the Akka documentation:

• = for sections
• - for subsections
• ^ for subsubsections
• ~ for subsubsubsections

Sections that may be cross-referenced across the documentation should be marked
with a reference. To mark a section use .. _ref-name: before the section
heading. The section can then be linked with `ref-name```. These are
unique references across the entire documentation.

For example::

.. _akka-module:

#

Akka Module

#

This is the module documentation.

Akka Section

Here is a reference to “akka section”: which will have the
name “Akka Section”.

Build the documentation

First install Sphinx_. See below.

For the html version of the docs::

For the pdf version of the docs::

sbt sphinx:generate-pdf
open <project-dir>/akka-docs/target/sphinx/latex/AkkaJava.pdf
or
open <project-dir>/akka-docs/target/sphinx/latex/AkkaScala.pdf

Install Homebrew <https://github.com/mxcl/homebrew>_

Install Python and pip:

::

  brew install python
  /usr/local/share/python/easy_install pip

Add the Homebrew Python path to your $PATH:

::

Install sphinx:

::

Add sphinx_build to your $PATH:

::

Install BasicTeX package from:

Add texlive bin to $PATH:

::

Add missing tex packages:

::

  sudo tlmgr update --self
  sudo tlmgr install titlesec
  sudo tlmgr install framed
  sudo tlmgr install threeparttable
  sudo tlmgr install wrapfig
  sudo tlmgr install helvetic
  sudo tlmgr install courier
  sudo tlmgr install multirow

::

  export LANG=en_US.UTF-8
  export LC_ALL=en_US.UTF-8