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.
27 lines
961 B
ReStructuredText
27 lines
961 B
ReStructuredText
.. _experimental:
|
|
|
|
####################
|
|
Experimental Modules
|
|
####################
|
|
|
|
The following modules of Akka are marked as experimental, which means
|
|
that they are in early access mode, which also means that they are not
|
|
covered by commercial support. The purpose of releasing them early, as
|
|
experimental, is to make them easily available and improve based on
|
|
feedback, or even discover that the module wasn't useful.
|
|
|
|
An experimental module doesn't have to obey the rule of staying binary
|
|
compatible between minor releases. Breaking API changes may be introduced
|
|
in minor releases without notice as we refine and simplify based on your
|
|
feedback. An experimental module may be dropped in major releases without
|
|
prior deprecation.
|
|
|
|
Another reason for marking a module as experimental is that it's too early
|
|
to tell if the module has a maintainer that can take the responsibility
|
|
of the module over time.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
../cluster/index
|
|
|