+pro,doc #15290 Add separate doc project for release-2.3-dev
* Create sepaate project for stream and http docs. * Make validatePullRequest run the relevant tests only.
This commit is contained in:
parent
e0b217fe21
commit
8dec2664fc
36 changed files with 2371 additions and 0 deletions
87
akka-docs-dev/rst/conf.py
Normal file
87
akka-docs-dev/rst/conf.py
Normal file
|
|
@ -0,0 +1,87 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Akka documentation build configuration file.
|
||||
#
|
||||
|
||||
import sys, os
|
||||
|
||||
# -- General configuration -----------------------------------------------------
|
||||
|
||||
sys.path.append(os.path.abspath('../_sphinx/exts'))
|
||||
extensions = ['sphinx.ext.todo', 'includecode']
|
||||
|
||||
templates_path = ['_templates']
|
||||
source_suffix = '.rst'
|
||||
master_doc = 'index'
|
||||
exclude_patterns = ['_build', 'pending', 'disabled']
|
||||
|
||||
project = u'Akka'
|
||||
copyright = u'2011-2014, Typesafe Inc'
|
||||
version = '@version@'
|
||||
release = '@version@'
|
||||
|
||||
pygments_style = 'simple'
|
||||
highlight_language = 'scala'
|
||||
add_function_parentheses = False
|
||||
show_authors = True
|
||||
|
||||
# -- Options for HTML output ---------------------------------------------------
|
||||
|
||||
html_theme = 'akka'
|
||||
html_theme_path = ['../_sphinx/themes']
|
||||
html_favicon = '../_sphinx/static/favicon.ico'
|
||||
|
||||
html_title = 'Akka Documentation'
|
||||
html_logo = '../_sphinx/static/logo.png'
|
||||
#html_favicon = None
|
||||
|
||||
html_static_path = ['../_sphinx/static']
|
||||
|
||||
html_last_updated_fmt = '%b %d, %Y'
|
||||
#html_sidebars = {}
|
||||
#html_additional_pages = {}
|
||||
html_domain_indices = False
|
||||
html_use_index = False
|
||||
html_show_sourcelink = False
|
||||
html_show_sphinx = False
|
||||
html_show_copyright = True
|
||||
htmlhelp_basename = 'Akkadoc'
|
||||
html_use_smartypants = False
|
||||
html_add_permalinks = ''
|
||||
|
||||
html_context = {
|
||||
'include_analytics': 'online' in tags
|
||||
}
|
||||
|
||||
# -- Options for EPUB output ---------------------------------------------------
|
||||
epub_author = "Typesafe Inc"
|
||||
epub_language = "en"
|
||||
epub_publisher = epub_author
|
||||
epub_identifier = "http://doc.akka.io/docs/akka/snapshot/"
|
||||
epub_scheme = "URL"
|
||||
epub_cover = ("../_sphinx/static/akka.png", "")
|
||||
|
||||
# -- Options for LaTeX output --------------------------------------------------
|
||||
|
||||
def setup(app):
|
||||
from sphinx.util.texescape import tex_replacements
|
||||
tex_replacements.append((u'⇒', ur'\(\Rightarrow\)'))
|
||||
|
||||
latex_paper_size = 'a4'
|
||||
latex_font_size = '10pt'
|
||||
|
||||
latex_documents = [
|
||||
('java', 'AkkaJava.tex', u' Akka Java Documentation',
|
||||
u'Typesafe Inc', 'manual'),
|
||||
('scala', 'AkkaScala.tex', u' Akka Scala Documentation',
|
||||
u'Typesafe Inc', 'manual'),
|
||||
]
|
||||
|
||||
latex_elements = {
|
||||
'classoptions': ',oneside,openany',
|
||||
'babel': '\\usepackage[english]{babel}',
|
||||
'fontpkg': '\\PassOptionsToPackage{warn}{textcomp} \\usepackage{times}',
|
||||
'preamble': '\\definecolor{VerbatimColor}{rgb}{0.935,0.935,0.935}'
|
||||
}
|
||||
|
||||
# latex_logo = '_sphinx/static/akka.png'
|
||||
21
akka-docs-dev/rst/experimental/index.rst
Normal file
21
akka-docs-dev/rst/experimental/index.rst
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
.. _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 micro 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 minor releases without
|
||||
prior deprecation.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
8
akka-docs-dev/rst/index.rst
Normal file
8
akka-docs-dev/rst/index.rst
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
Contents
|
||||
========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
java
|
||||
scala
|
||||
9
akka-docs-dev/rst/java.rst
Normal file
9
akka-docs-dev/rst/java.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _java-api:
|
||||
|
||||
Java Documentation
|
||||
==================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
experimental/index
|
||||
9
akka-docs-dev/rst/scala.rst
Normal file
9
akka-docs-dev/rst/scala.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
.. _scala-api:
|
||||
|
||||
Scala Documentation
|
||||
===================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
experimental/index
|
||||
Loading…
Add table
Add a link
Reference in a new issue