Commit graph

38 commits

Author SHA1 Message Date
Roland
9bc01ae265 add preprocessor for RST docs, see #2461 and #2431
The idea is to filter the sources, replacing @<var>@ occurrences with
the mapping for <var> (which is currently hard-coded). @@ -> @. In order
to make this work, I had to move the doc sources one directory down
(into akka-docs/rst) so that the filtered result could be in a sibling
directory so that relative links (to _sphinx plugins or real code) would
continue to work.

While I was at it I also changed it so that WARNINGs and ERRORs are not
swallowed into the debug dump anymore but printed at [warn] level
(minimum).

One piece of fallout is that the (online) html build is now run after
the normal one, not in parallel.
2012-09-21 13:58:47 +02:00
Roland
d41160f4bf automatically reference right scalaVersion in RST
using epilog_rst configuration variable in sphinx, which reads
akka-docs/epilog_rst, which is written in sphinx-scala-version task by
SBT, which is referenced by the other docs tasks as a dependency
2012-08-17 00:07:56 +02:00
Roland
b9e91d69d7 correct reference to scalaVersion in docs 2012-08-12 10:34:14 +02:00
viktorklang
60c11cab7b Adding missing slash 2012-06-07 00:46:01 +03:00
Roland
dd30e81a1a document Specs2 + TestKit, see #2068, plus fix up broken includes
- include move of doc samples out of akka package also in the
  includecode directives
- fix broken serialization docs, which require one thing in the akka
  package
2012-05-24 22:23:36 +02:00
Jonas Bonér
41ba88e1f8 Cleaned up akka-docs, removed old and unused docs, fixed some errors etc. 2012-05-11 10:00:12 +02:00
Havoc Pennington
0d6dec1c4b rename a doc section to refer to multiple ActorSystem
this better tells people when to read this section.
2012-05-03 10:21:24 -04:00
Havoc Pennington
3e68bef199 move the docs on config file prior to docs on coding custom config
Assume people first try just editing files, and only write custom
code if they are getting fancy.
2012-05-03 10:18:44 -04:00
Havoc Pennington
340b4dd8a5 in docs, discuss using "include" instead of coding custom config 2012-05-03 10:16:32 -04:00
Havoc Pennington
c3124f45eb move custom config example in Java into a code file 2012-05-03 10:10:25 -04:00
Havoc Pennington
ab7ea72200 move the new doc section on custom config to a better place
there was already some mention of it so move the longer
mention to just after the initial mention
2012-05-03 10:00:14 -04:00
Havoc Pennington
7ba3ccff47 Move reference config listings to bottom of the page
There were some docs, then some huge listings, then
more docs; I'm guessing people often don't scroll
down past the huge listings so move them to the
bottom.
2012-05-03 09:44:31 -04:00
Havoc Pennington
d4c838a505 add docs on loading configuration from custom place 2012-05-03 09:44:31 -04:00
viktorklang
b54d125662 Adding documentation about working around the REPL bug. 2012-04-27 12:24:32 +03:00
Viktor Klang
96e5682732 #1957 - Adding warning section regarding jarjar and akka configuration 2012-04-03 00:12:12 +02:00
Peter Vlugter
d7fe025fa2 Update docs theme 2012-03-06 13:20:00 +13:00
Roland
56ce7a0ecd rewrite configuration.rst, see #1823 and #1838 2012-03-05 15:39:46 +01:00
Patrik Nordwall
e017aeef08 Replace akka.actor.timeout with specfic settings. See #1808
* ActorTimeout (akka.actor.timeout) was used to all sorts of things.
* TestKit default-timeout
* TypedActor timeout for non void methods
* Transactor coordinated-timeout
* ZeroMQ new-socket-timeout
* And in various tests
2012-02-10 16:07:17 +01:00
Jonas Bonér
51a218b87f Fixes ticket #1809 - Harmonize configuration option names.
Signed-off-by: Jonas Bonér <jonas@jonasboner.com>
2012-02-09 20:40:09 +01:00
Roland
4fb0858e55 remote cleanup: include feedback from Viktor and Patrik
- re-label Client/Server to Inbound/Outbound for netty settings
  description
- move to just using exactly one class loader for all reflective
  activities of the ActorSystem, which is either the context class
  loader or the one which loaded the ActorSystem’s class; document that
  putting Akka on boot class path will not work
- be more careful with initializing the Client- and ServerBootstrap
- rename Port to DesiredPortFromConfig to discourage misuse
- write test for NettySettings
- various small fixes
2012-01-30 11:57:24 +01:00
Patrik Nordwall
05d4a6ed38 DOC: Extension sample for application specific settings. See #1702
* Added sample and documentation for how to create extension for application specific config
* Simplified java usage of ExtensionIdProvider, more aligned with how it is done in scala
2012-01-20 11:30:33 +01:00
Roland
a917260488 add examples for printing out configuration 2011-12-26 19:01:37 +01:00
Jonas Bonér
ce296b0481 Misc additions to, and rewrites and formatting of, the documentation.
Signed-off-by: Jonas Bonér <jonas@jonasboner.com>
2011-12-15 14:26:17 +01:00
Patrik Nordwall
8ffa85c590 DOC: Rewrite config comments. See #1505 2011-12-14 15:12:40 +01:00
Patrik Nordwall
31e2cb354f Updated to latest config release from typesafehub, v0.1.8 2011-12-13 15:28:14 +01:00
patriknw
2f8706ee3a Merge pull request #149 from jboner/wip-doc-dispatchers-scala-patriknw
DOC: Update Dispatchers (Scala) Chapter
2011-12-13 06:05:47 -08:00
Patrik Nordwall
7a17eb00bf DOC: Corrections of dispatcher docs from review. See #1471 2011-12-13 15:03:32 +01:00
Patrik Nordwall
0239106fcc DOC: Updated logging documentation. See #1467 2011-12-13 12:33:58 +01:00
Patrik Nordwall
884dc43a7d DOC: Replace all akka.conf references. Fixes #1469
* Let us use :ref:`configuration` in all places to refer to the configuration.
2011-12-09 13:27:27 +01:00
Patrik Nordwall
c8a1a96310 Updated config documentation 2011-12-05 10:41:36 +01:00
Patrik Nordwall
b56201ab7f Updated to latest config lib and changed how reference config files are loaded.
* Config lib 4f3a91f
* All reference files named reference.conf, all will be loaded
* Usage of ConfigFactor.load as default way
* Extensions use same config as ActorSystem.settings.config
2011-11-29 11:56:41 +01:00
Patrik Nordwall
19a78c0e58 Slf4jEventHandler should not format log message. See #1401
* Updated documentation with info about MDC.
* Updated documentation conf of logLevel.
* Updated documentation Logback 1.0.0.
2011-11-28 10:07:30 +01:00
Patrik Nordwall
179399296e Modularize configuration. See #1361
* Split config reference to one for each module/extension.
* Adjusted signature of registerExtension to avoid race of extension init
* Moved Duration.dilated to testkit
* TestKitExtension
* RemoteExtension
* SerializationExtension
* Durable mailboxes extensions
* Fixed broken serialization bindings and added test
* Updated configuration documentation
* System properties akka.remote.hostname akka.remote.port replaced with akka.remote.server.hostname and akka.remote.server.port
* Adjustments of ActorSystem initialization. Still don't like the two-phase constructor/init flow. Very fragile for changes.

Review fixes. SerializationExtension
2011-11-23 20:31:58 +01:00
Peter Vlugter
7884691d3a Begin using compiled code examples in the docs. See #781 2011-10-05 17:41:29 +02:00
Viktor Klang
3181905fed Renaming EBEDD to Dispatcher, EBEDWSD to BalancingDispatcher, ThreadBasedDispatcher to PinnedDispatcher and PEBEDD to PriorityDispatcher, closing ticket #784 2011-05-20 22:56:30 +02:00
Roland
04541c3009 add summary of system properties to configuration.rst 2011-05-15 00:24:12 +02:00
Patrik Nordwall
c7444193e6 Ticket 739. Beefing up config documentation. 2011-05-01 17:35:05 +02:00
Peter Vlugter
2a4e967353 Move building and configuration to general 2011-04-27 09:37:14 +12:00
Renamed from akka-docs/intro/configuration.rst (Browse further)