mirror of
https://github.com/corda/corda.git
synced 2024-12-18 20:47:57 +00:00
[CORDA-1612]: Fix truncated code snippets in docs PDF (#3347)
This commit is contained in:
parent
d5d46c674d
commit
e2701e69d6
@ -16,6 +16,8 @@ endif
|
|||||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||||
PAPEROPT_letter = -D latex_paper_size=letter
|
PAPEROPT_letter = -D latex_paper_size=letter
|
||||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||||
|
HTMLSPHINXOPTS = $(ALLSPHINXOPTS) -t htmlmode
|
||||||
|
PDFSPHINXOPTS = $(ALLSPHINXOPTS) -t pdfmode
|
||||||
# the i18n builder cannot share the environment and doctrees with the others
|
# the i18n builder cannot share the environment and doctrees with the others
|
||||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||||
|
|
||||||
@ -52,17 +54,17 @@ clean:
|
|||||||
rm -rf $(BUILDDIR)/*
|
rm -rf $(BUILDDIR)/*
|
||||||
|
|
||||||
html:
|
html:
|
||||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
$(SPHINXBUILD) -b html $(HTMLSPHINXOPTS) $(BUILDDIR)/html
|
||||||
@echo
|
@echo
|
||||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||||
|
|
||||||
dirhtml:
|
dirhtml:
|
||||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
$(SPHINXBUILD) -b dirhtml $(HTMLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||||
@echo
|
@echo
|
||||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||||
|
|
||||||
singlehtml:
|
singlehtml:
|
||||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
$(SPHINXBUILD) -b singlehtml $(HTMLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||||
@echo
|
@echo
|
||||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||||
|
|
||||||
@ -77,7 +79,7 @@ json:
|
|||||||
@echo "Build finished; now you can process the JSON files."
|
@echo "Build finished; now you can process the JSON files."
|
||||||
|
|
||||||
htmlhelp:
|
htmlhelp:
|
||||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
$(SPHINXBUILD) -b htmlhelp $(HTMLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||||
@echo
|
@echo
|
||||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||||
@ -114,20 +116,20 @@ epub:
|
|||||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||||
|
|
||||||
latex:
|
latex:
|
||||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
$(SPHINXBUILD) -b latex $(PDFSPHINXOPTS) $(BUILDDIR)/latex
|
||||||
@echo
|
@echo
|
||||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||||
"(use \`make latexpdf' here to do that automatically)."
|
"(use \`make latexpdf' here to do that automatically)."
|
||||||
|
|
||||||
latexpdf:
|
latexpdf:
|
||||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
$(SPHINXBUILD) -b latex $(PDFSPHINXOPTS) $(BUILDDIR)/latex
|
||||||
@echo "Running LaTeX files through pdflatex..."
|
@echo "Running LaTeX files through pdflatex..."
|
||||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||||
|
|
||||||
latexpdfja:
|
latexpdfja:
|
||||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
$(SPHINXBUILD) -b latex $(PDFSPHINXOPTS) $(BUILDDIR)/latex
|
||||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||||
@ -192,4 +194,4 @@ pseudoxml:
|
|||||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||||
|
|
||||||
pdf:
|
pdf:
|
||||||
$(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf
|
$(SPHINXBUILD) -b pdf $(PDFSPHINXOPTS) $(BUILDDIR)/pdf
|
||||||
|
@ -13,11 +13,10 @@ fi
|
|||||||
|
|
||||||
# TODO: The PDF rendering is pretty ugly and can be improved a lot.
|
# TODO: The PDF rendering is pretty ugly and can be improved a lot.
|
||||||
echo "Generating PDF document ..."
|
echo "Generating PDF document ..."
|
||||||
make pdf
|
make latexpdf
|
||||||
|
|
||||||
echo "Generating HTML pages ..."
|
echo "Generating HTML pages ..."
|
||||||
make html
|
make html
|
||||||
|
|
||||||
echo "Moving PDF file into place ..."
|
echo "Moving PDF file from $(eval echo $PWD/build/pdf/corda-developer-site.pdf) to $(eval echo $PWD/build/html/_static/corda-developer-site.pdf)"
|
||||||
mv $PWD/build/pdf/corda-developer-site.pdf $PWD/build/html/_static/corda-developer-site.pdf
|
mv $PWD/build/latex/corda-developer-site.pdf $PWD/build/html/_static/corda-developer-site.pdf
|
||||||
|
|
@ -7,6 +7,8 @@ release, see :doc:`upgrade-notes`.
|
|||||||
Unreleased
|
Unreleased
|
||||||
==========
|
==========
|
||||||
|
|
||||||
|
* Improved documentation PDF quality. Building the documentation now requires ``LaTex`` to be installed on the OS.
|
||||||
|
|
||||||
* Add ``devModeOptions.allowCompatibilityZone`` to re-enable the use of a compatibility zone and ``devMode``
|
* Add ``devModeOptions.allowCompatibilityZone`` to re-enable the use of a compatibility zone and ``devMode``
|
||||||
|
|
||||||
* Fixed an issue where ``trackBy`` was returning ``ContractStates`` from a transaction that were not being tracked. The
|
* Fixed an issue where ``trackBy`` was returning ``ContractStates`` from a transaction that were not being tracked. The
|
||||||
@ -153,7 +155,7 @@ Version 3.1
|
|||||||
* Update the fast-classpath-scanner dependent library version from 2.0.21 to 2.12.3
|
* Update the fast-classpath-scanner dependent library version from 2.0.21 to 2.12.3
|
||||||
|
|
||||||
.. note:: Whilst this is not the latest version of this library, that being 2.18.1 at time of writing, versions
|
.. note:: Whilst this is not the latest version of this library, that being 2.18.1 at time of writing, versions
|
||||||
later than 2.12.3 (including 2.12.4) exhibit a different issue.
|
later than 2.12.3 (including 2.12.4) exhibit a different issue.
|
||||||
|
|
||||||
* Updated the api scanner gradle plugin to work the same way as the version in master. These changes make the api scanner more
|
* Updated the api scanner gradle plugin to work the same way as the version in master. These changes make the api scanner more
|
||||||
accurate and fix a couple of bugs, and change the format of the api-current.txt file slightly. Backporting these changes
|
accurate and fix a couple of bugs, and change the format of the api-current.txt file slightly. Backporting these changes
|
||||||
@ -971,15 +973,15 @@ Special thank you to `Qian Hong <https://github.com/fracting>`_, `Marek Skocovsk
|
|||||||
to Corda in M10.
|
to Corda in M10.
|
||||||
|
|
||||||
.. warning:: Due to incompatibility between older version of IntelliJ and gradle 3.4, you will need to upgrade Intellij
|
.. warning:: Due to incompatibility between older version of IntelliJ and gradle 3.4, you will need to upgrade Intellij
|
||||||
to 2017.1 (with kotlin-plugin v1.1.1) in order to run Corda demos in IntelliJ. You can download the latest IntelliJ
|
to 2017.1 (with kotlin-plugin v1.1.1) in order to run Corda demos in IntelliJ. You can download the latest IntelliJ
|
||||||
from `JetBrains <https://www.jetbrains.com/idea/download/>`_.
|
from `JetBrains <https://www.jetbrains.com/idea/download/>`_.
|
||||||
|
|
||||||
.. warning:: The Kapt-generated models are no longer included in our codebase. If you experience ``unresolved references``
|
.. warning:: The Kapt-generated models are no longer included in our codebase. If you experience ``unresolved references``
|
||||||
errors when building in IntelliJ, please rebuild the schema model by running ``gradlew kaptKotlin`` in Windows or
|
errors when building in IntelliJ, please rebuild the schema model by running ``gradlew kaptKotlin`` in Windows or
|
||||||
``./gradlew kaptKotlin`` in other systems. Alternatively, perform a full gradle build or install.
|
``./gradlew kaptKotlin`` in other systems. Alternatively, perform a full gradle build or install.
|
||||||
|
|
||||||
.. note:: Kapt is used to generate schema model and entity code (from annotations in the codebase) using the Kotlin Annotation
|
.. note:: Kapt is used to generate schema model and entity code (from annotations in the codebase) using the Kotlin Annotation
|
||||||
processor.
|
processor.
|
||||||
|
|
||||||
* Corda DemoBench:
|
* Corda DemoBench:
|
||||||
* DemoBench is a new tool to make it easy to configure and launch local Corda nodes. A very useful tool to demonstrate
|
* DemoBench is a new tool to make it easy to configure and launch local Corda nodes. A very useful tool to demonstrate
|
||||||
|
@ -14,16 +14,15 @@
|
|||||||
|
|
||||||
import sphinx_rtd_theme
|
import sphinx_rtd_theme
|
||||||
|
|
||||||
|
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
# add these directories to sys.path here. If the directory is relative to the
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||||
#sys.path.insert(0, os.path.abspath('.'))
|
# sys.path.insert(0, os.path.abspath('.'))
|
||||||
|
|
||||||
# -- General configuration ------------------------------------------------
|
# -- General configuration ------------------------------------------------
|
||||||
|
|
||||||
# If your documentation needs a minimal Sphinx version, state it here.
|
# If your documentation needs a minimal Sphinx version, state it here.
|
||||||
#needs_sphinx = '1.0'
|
# needs_sphinx = '1.0'
|
||||||
|
|
||||||
# m2r is a Markdown to RST converter, as our design docs use Markdown.
|
# m2r is a Markdown to RST converter, as our design docs use Markdown.
|
||||||
extensions = ['rst2pdf.pdfbuilder', 'm2r']
|
extensions = ['rst2pdf.pdfbuilder', 'm2r']
|
||||||
@ -33,6 +32,7 @@ pdf_documents = [('index', u'corda-developer-site', u'Corda Developer Documentat
|
|||||||
pdf_stylesheets = ['sphinx', 'kerning', 'a4', 'murphy', 'tenpoint']
|
pdf_stylesheets = ['sphinx', 'kerning', 'a4', 'murphy', 'tenpoint']
|
||||||
pdf_compressed = True
|
pdf_compressed = True
|
||||||
pdf_fit_mode = "shrink"
|
pdf_fit_mode = "shrink"
|
||||||
|
pdf_fit_background_mode = "shrink"
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['_templates']
|
templates_path = ['_templates']
|
||||||
@ -72,28 +72,30 @@ language = None
|
|||||||
|
|
||||||
# There are two options for replacing |today|: either, you set today to some
|
# There are two options for replacing |today|: either, you set today to some
|
||||||
# non-false value, then it is used:
|
# non-false value, then it is used:
|
||||||
#today = ''
|
# today = ''
|
||||||
# Else, today_fmt is used as the format for a strftime call.
|
# Else, today_fmt is used as the format for a strftime call.
|
||||||
#today_fmt = '%B %d, %Y'
|
# today_fmt = '%B %d, %Y'
|
||||||
|
|
||||||
# List of patterns, relative to source directory, that match files and
|
# List of patterns, relative to source directory, that match files and
|
||||||
# directories to ignore when looking for source files.
|
# directories to ignore when looking for source files.
|
||||||
exclude_patterns = []
|
exclude_patterns = []
|
||||||
|
if tags.has('pdfmode'):
|
||||||
|
exclude_patterns = ['./design']
|
||||||
|
|
||||||
# The reST default role (used for this markup: `text`) to use for all
|
# The reST default role (used for this markup: `text`) to use for all
|
||||||
# documents.
|
# documents.
|
||||||
#default_role = None
|
# default_role = None
|
||||||
|
|
||||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||||
#add_function_parentheses = True
|
# add_function_parentheses = True
|
||||||
|
|
||||||
# If true, the current module name will be prepended to all description
|
# If true, the current module name will be prepended to all description
|
||||||
# unit titles (such as .. function::).
|
# unit titles (such as .. function::).
|
||||||
#add_module_names = True
|
# add_module_names = True
|
||||||
|
|
||||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||||
# output. They are ignored by default.
|
# output. They are ignored by default.
|
||||||
#show_authors = False
|
# show_authors = False
|
||||||
|
|
||||||
# The name of the Pygments (syntax highlighting) style to use.
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
pygments_style = 'sphinx'
|
pygments_style = 'sphinx'
|
||||||
@ -101,15 +103,14 @@ pygments_style = 'sphinx'
|
|||||||
highlight_language = 'kotlin'
|
highlight_language = 'kotlin'
|
||||||
|
|
||||||
# A list of ignored prefixes for module index sorting.
|
# A list of ignored prefixes for module index sorting.
|
||||||
#modindex_common_prefix = []
|
# modindex_common_prefix = []
|
||||||
|
|
||||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||||
#keep_warnings = False
|
# keep_warnings = False
|
||||||
|
|
||||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||||
todo_include_todos = False
|
todo_include_todos = False
|
||||||
|
|
||||||
|
|
||||||
# -- Options for HTML output ----------------------------------------------
|
# -- Options for HTML output ----------------------------------------------
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
@ -125,21 +126,21 @@ html_add_permalinks = True
|
|||||||
# Theme options are theme-specific and customize the look and feel of a theme
|
# Theme options are theme-specific and customize the look and feel of a theme
|
||||||
# further. For a list of options available for each theme, see the
|
# further. For a list of options available for each theme, see the
|
||||||
# documentation.
|
# documentation.
|
||||||
#html_theme_options = {}
|
# html_theme_options = {}
|
||||||
|
|
||||||
# Add any paths that contain custom themes here, relative to this directory.
|
# Add any paths that contain custom themes here, relative to this directory.
|
||||||
#html_theme_path = []
|
# html_theme_path = []
|
||||||
|
|
||||||
# The name for this set of Sphinx documents. If None, it defaults to
|
# The name for this set of Sphinx documents. If None, it defaults to
|
||||||
# "<project> v<release> documentation".
|
# "<project> v<release> documentation".
|
||||||
#html_title = None
|
# html_title = None
|
||||||
|
|
||||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||||
#html_short_title = None
|
# html_short_title = None
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top
|
# The name of an image file (relative to this directory) to place at the top
|
||||||
# of the sidebar.
|
# of the sidebar.
|
||||||
#html_logo = None
|
# html_logo = None
|
||||||
|
|
||||||
# The name of an image file (within the static path) to use as favicon of the
|
# The name of an image file (within the static path) to use as favicon of the
|
||||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||||
@ -156,103 +157,101 @@ html_style = 'css/custom.css'
|
|||||||
# Add any extra paths that contain custom files (such as robots.txt or
|
# Add any extra paths that contain custom files (such as robots.txt or
|
||||||
# .htaccess) here, relative to this directory. These files are copied
|
# .htaccess) here, relative to this directory. These files are copied
|
||||||
# directly to the root of the documentation.
|
# directly to the root of the documentation.
|
||||||
#html_extra_path = []
|
# html_extra_path = []
|
||||||
|
|
||||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||||
# using the given strftime format.
|
# using the given strftime format.
|
||||||
#html_last_updated_fmt = '%b %d, %Y'
|
# html_last_updated_fmt = '%b %d, %Y'
|
||||||
|
|
||||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||||
# typographically correct entities.
|
# typographically correct entities.
|
||||||
#html_use_smartypants = True
|
# html_use_smartypants = True
|
||||||
|
|
||||||
# Additional templates that should be rendered to pages, maps page names to
|
# Additional templates that should be rendered to pages, maps page names to
|
||||||
# template names.
|
# template names.
|
||||||
#html_additional_pages = {}
|
# html_additional_pages = {}
|
||||||
|
|
||||||
# If false, no module index is generated.
|
# If false, no module index is generated.
|
||||||
#html_domain_indices = True
|
# html_domain_indices = True
|
||||||
|
|
||||||
# If false, no index is generated.
|
# If false, no index is generated.
|
||||||
#html_use_index = True
|
# html_use_index = True
|
||||||
|
|
||||||
# If true, the index is split into individual pages for each letter.
|
# If true, the index is split into individual pages for each letter.
|
||||||
#html_split_index = False
|
# html_split_index = False
|
||||||
|
|
||||||
# If true, links to the reST sources are added to the pages.
|
# If true, links to the reST sources are added to the pages.
|
||||||
#html_show_sourcelink = True
|
# html_show_sourcelink = True
|
||||||
|
|
||||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||||
#html_show_sphinx = True
|
# html_show_sphinx = True
|
||||||
|
|
||||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||||
#html_show_copyright = True
|
# html_show_copyright = True
|
||||||
|
|
||||||
# If true, an OpenSearch description file will be output, and all pages will
|
# If true, an OpenSearch description file will be output, and all pages will
|
||||||
# contain a <link> tag referring to it. The value of this option must be the
|
# contain a <link> tag referring to it. The value of this option must be the
|
||||||
# base URL from which the finished HTML is served.
|
# base URL from which the finished HTML is served.
|
||||||
#html_use_opensearch = ''
|
# html_use_opensearch = ''
|
||||||
|
|
||||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||||
#html_file_suffix = None
|
# html_file_suffix = None
|
||||||
|
|
||||||
# Language to be used for generating the HTML full-text search index.
|
# Language to be used for generating the HTML full-text search index.
|
||||||
# Sphinx supports the following languages:
|
# Sphinx supports the following languages:
|
||||||
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
|
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
|
||||||
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
|
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
|
||||||
#html_search_language = 'en'
|
# html_search_language = 'en'
|
||||||
|
|
||||||
# A dictionary with options for the search language support, empty by default.
|
# A dictionary with options for the search language support, empty by default.
|
||||||
# Now only 'ja' uses this config value
|
# Now only 'ja' uses this config value
|
||||||
#html_search_options = {'type': 'default'}
|
# html_search_options = {'type': 'default'}
|
||||||
|
|
||||||
# The name of a javascript file (relative to the configuration directory) that
|
# The name of a javascript file (relative to the configuration directory) that
|
||||||
# implements a search results scorer. If empty, the default will be used.
|
# implements a search results scorer. If empty, the default will be used.
|
||||||
#html_search_scorer = 'scorer.js'
|
# html_search_scorer = 'scorer.js'
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = 'R3doc'
|
htmlhelp_basename = 'R3doc'
|
||||||
|
|
||||||
# -- Options for LaTeX output ---------------------------------------------
|
# -- Options for LaTeX output ---------------------------------------------
|
||||||
|
|
||||||
latex_elements = {
|
latex_documents = [('index', u'corda-developer-site.tex', u'Corda Developer Documentation', u'R3', 'manual', False)]
|
||||||
# The paper size ('letterpaper' or 'a4paper').
|
|
||||||
#'papersize': 'letterpaper',
|
|
||||||
|
|
||||||
# The font size ('10pt', '11pt' or '12pt').
|
|
||||||
#'pointsize': '10pt',
|
|
||||||
|
|
||||||
# Additional stuff for the LaTeX preamble.
|
|
||||||
#'preamble': '',
|
|
||||||
|
|
||||||
# Latex figure (float) alignment
|
|
||||||
#'figure_align': 'htbp',
|
|
||||||
}
|
|
||||||
|
|
||||||
# Grouping the document tree into LaTeX files. List of tuples
|
|
||||||
# (source start file, target name, title,
|
|
||||||
# author, documentclass [howto, manual, or own class]).
|
|
||||||
latex_documents = [
|
|
||||||
(master_doc, 'R3Prototyping.tex', u'R3 Prototyping Documentation',
|
|
||||||
u'R3 CEV', 'manual'),
|
|
||||||
]
|
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top of
|
# The name of an image file (relative to this directory) to place at the top of
|
||||||
# the title page.
|
# the title page.
|
||||||
#latex_logo = None
|
# latex_logo = None
|
||||||
|
|
||||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||||
# not chapters.
|
# not chapters.
|
||||||
#latex_use_parts = False
|
# latex_use_parts = False
|
||||||
|
|
||||||
# If true, show page references after internal links.
|
# If true, show page references after internal links.
|
||||||
#latex_show_pagerefs = False
|
# latex_show_pagerefs = False
|
||||||
|
|
||||||
# If true, show URL addresses after external links.
|
# If true, show URL addresses after external links.
|
||||||
#latex_show_urls = False
|
# latex_show_urls = False
|
||||||
|
|
||||||
# Documents to append as an appendix to all manuals.
|
# Documents to append as an appendix to all manuals.
|
||||||
#latex_appendices = []
|
# latex_appendices = []
|
||||||
|
|
||||||
# If false, no module index is generated.
|
# If false, no module index is generated.
|
||||||
#latex_domain_indices = True
|
# latex_domain_indices = True
|
||||||
|
|
||||||
|
latex_elements = {
|
||||||
|
# The paper size ('letterpaper' or 'a4paper').
|
||||||
|
# 'papersize': 'letterpaper',
|
||||||
|
|
||||||
|
# The font size ('10pt', '11pt' or '12pt').
|
||||||
|
# 'pointsize': '10pt',
|
||||||
|
|
||||||
|
# Additional stuff for the LaTeX preamble.
|
||||||
|
# 'preamble': '',
|
||||||
|
|
||||||
|
# Latex figure (float) alignment
|
||||||
|
# 'figure_align': 'htbp',
|
||||||
|
|
||||||
|
'maxlistdepth': 2000,
|
||||||
|
|
||||||
|
'extraclassoptions': 'openany',
|
||||||
|
}
|
||||||
|
@ -53,24 +53,26 @@ We look forward to seeing what you can do with Corda!
|
|||||||
aws-vm.rst
|
aws-vm.rst
|
||||||
loadtesting.rst
|
loadtesting.rst
|
||||||
|
|
||||||
.. toctree::
|
.. only:: htmlmode
|
||||||
:caption: Design docs
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
design/design-review-process.md
|
.. toctree::
|
||||||
design/certificate-hierarchies/design.md
|
:caption: Design docs
|
||||||
design/failure-detection-master-election/design.md
|
:maxdepth: 2
|
||||||
design/float/design.md
|
|
||||||
design/hadr/design.md
|
|
||||||
design/kafka-notary/design.md
|
|
||||||
design/monitoring-management/design.md
|
|
||||||
design/sgx-integration/design.md
|
|
||||||
|
|
||||||
.. toctree::
|
design/design-review-process.md
|
||||||
:caption: Participate
|
design/certificate-hierarchies/design.md
|
||||||
:maxdepth: 2
|
design/failure-detection-master-election/design.md
|
||||||
|
design/float/design.md
|
||||||
|
design/hadr/design.md
|
||||||
|
design/kafka-notary/design.md
|
||||||
|
design/monitoring-management/design.md
|
||||||
|
design/sgx-integration/design.md
|
||||||
|
|
||||||
release-process-index.rst
|
.. toctree::
|
||||||
corda-repo-layout.rst
|
:caption: Participate
|
||||||
deterministic-modules.rst
|
:maxdepth: 2
|
||||||
building-the-docs.rst
|
|
||||||
|
release-process-index.rst
|
||||||
|
corda-repo-layout.rst
|
||||||
|
deterministic-modules.rst
|
||||||
|
building-the-docs.rst
|
@ -7,12 +7,15 @@ Consensus
|
|||||||
* *Validity consensus requires contractual validity of the transaction and all its dependencies*
|
* *Validity consensus requires contractual validity of the transaction and all its dependencies*
|
||||||
* *Uniqueness consensus prevents double-spends*
|
* *Uniqueness consensus prevents double-spends*
|
||||||
|
|
||||||
Video
|
.. only:: htmlmode
|
||||||
-----
|
|
||||||
.. raw:: html
|
Video
|
||||||
|
-----
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<iframe src="https://player.vimeo.com/video/214138438" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
<iframe src="https://player.vimeo.com/video/214138438" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
|
||||||
<p></p>
|
|
||||||
|
|
||||||
Two types of consensus
|
Two types of consensus
|
||||||
----------------------
|
----------------------
|
||||||
|
@ -7,12 +7,15 @@ Contracts
|
|||||||
* *Contracts are written in a JVM programming language (e.g. Java or Kotlin)*
|
* *Contracts are written in a JVM programming language (e.g. Java or Kotlin)*
|
||||||
* *Contract execution is deterministic and its acceptance of a transaction is based on the transaction's contents alone*
|
* *Contract execution is deterministic and its acceptance of a transaction is based on the transaction's contents alone*
|
||||||
|
|
||||||
Video
|
.. only:: htmlmode
|
||||||
-----
|
|
||||||
.. raw:: html
|
Video
|
||||||
|
-----
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<iframe src="https://player.vimeo.com/video/214168839" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
<iframe src="https://player.vimeo.com/video/214168839" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
|
||||||
<p></p>
|
|
||||||
|
|
||||||
Transaction verification
|
Transaction verification
|
||||||
------------------------
|
------------------------
|
||||||
|
@ -7,12 +7,15 @@ Flows
|
|||||||
* *Communication between nodes only occurs in the context of these flows, and is point-to-point*
|
* *Communication between nodes only occurs in the context of these flows, and is point-to-point*
|
||||||
* *Built-in flows are provided to automate common tasks*
|
* *Built-in flows are provided to automate common tasks*
|
||||||
|
|
||||||
Video
|
.. only:: htmlmode
|
||||||
-----
|
|
||||||
.. raw:: html
|
Video
|
||||||
|
-----
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<iframe src="https://player.vimeo.com/video/214046145" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
<iframe src="https://player.vimeo.com/video/214046145" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
|
||||||
<p></p>
|
|
||||||
|
|
||||||
Motivation
|
Motivation
|
||||||
----------
|
----------
|
||||||
@ -22,9 +25,19 @@ what order.
|
|||||||
|
|
||||||
Here is a visualisation of the process of agreeing a simple ledger update between Alice and Bob:
|
Here is a visualisation of the process of agreeing a simple ledger update between Alice and Bob:
|
||||||
|
|
||||||
.. image:: resources/flow.gif
|
.. only:: htmlmode
|
||||||
:scale: 25%
|
|
||||||
:align: center
|
.. image:: resources/flow.gif
|
||||||
|
:scale: 25%
|
||||||
|
:align: center
|
||||||
|
|
||||||
|
|
||||||
|
.. only:: pdfmode
|
||||||
|
|
||||||
|
.. image:: resources/flow.png
|
||||||
|
:scale: 25%
|
||||||
|
:align: center
|
||||||
|
|
||||||
|
|
||||||
The flow framework
|
The flow framework
|
||||||
------------------
|
------------------
|
||||||
|
@ -6,12 +6,15 @@ The ledger
|
|||||||
* *The ledger is subjective from each peer's perspective*
|
* *The ledger is subjective from each peer's perspective*
|
||||||
* *Two peers are always guaranteed to see the exact same version of any on-ledger facts they share*
|
* *Two peers are always guaranteed to see the exact same version of any on-ledger facts they share*
|
||||||
|
|
||||||
Video
|
.. only:: htmlmode
|
||||||
-----
|
|
||||||
.. raw:: html
|
Video
|
||||||
|
-----
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<iframe src="https://player.vimeo.com/video/213812040" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
<iframe src="https://player.vimeo.com/video/213812040" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
|
||||||
<p></p>
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
--------
|
--------
|
||||||
|
@ -11,13 +11,16 @@ Nodes
|
|||||||
|
|
||||||
* *The node's functionality is extended by installing CorDapps in the plugin registry*
|
* *The node's functionality is extended by installing CorDapps in the plugin registry*
|
||||||
|
|
||||||
Video
|
.. only:: htmlmode
|
||||||
-----
|
|
||||||
.. raw:: html
|
Video
|
||||||
|
-----
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<p><a href="https://vimeo.com/214168860">Corda Node, CorDapps and Network</a></p>
|
||||||
|
<iframe src="https://player.vimeo.com/video/214168860" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
<p><a href="https://vimeo.com/214168860">Corda Node, CorDapps and Network</a></p>
|
|
||||||
<iframe src="https://player.vimeo.com/video/214168860" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
|
||||||
<p></p>
|
|
||||||
|
|
||||||
Node architecture
|
Node architecture
|
||||||
-----------------
|
-----------------
|
||||||
|
@ -7,12 +7,15 @@ Notaries
|
|||||||
* *Notary clusters may optionally also validate transactions*
|
* *Notary clusters may optionally also validate transactions*
|
||||||
* *A network can have several notary clusters, each running a different consensus algorithm*
|
* *A network can have several notary clusters, each running a different consensus algorithm*
|
||||||
|
|
||||||
Video
|
.. only:: htmlmode
|
||||||
-----
|
|
||||||
.. raw:: html
|
Video
|
||||||
|
-----
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<iframe src="https://player.vimeo.com/video/214138458" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
<iframe src="https://player.vimeo.com/video/214138458" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
|
||||||
<p></p>
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
--------
|
--------
|
||||||
|
@ -6,12 +6,15 @@ Oracles
|
|||||||
* *A fact can be included in a transaction as part of a command*
|
* *A fact can be included in a transaction as part of a command*
|
||||||
* *An oracle is a service that will only sign the transaction if the included fact is true*
|
* *An oracle is a service that will only sign the transaction if the included fact is true*
|
||||||
|
|
||||||
Video
|
.. only:: htmlmode
|
||||||
-----
|
|
||||||
.. raw:: html
|
Video
|
||||||
|
-----
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<iframe src="https://player.vimeo.com/video/214157956" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
<iframe src="https://player.vimeo.com/video/214157956" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
|
||||||
<p></p>
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
--------
|
--------
|
||||||
|
@ -7,12 +7,15 @@ States
|
|||||||
* *States are evolved by marking the current state as historic and creating an updated state*
|
* *States are evolved by marking the current state as historic and creating an updated state*
|
||||||
* *Each node has a vault where it stores any relevant states to itself*
|
* *Each node has a vault where it stores any relevant states to itself*
|
||||||
|
|
||||||
Video
|
.. only:: htmlmode
|
||||||
-----
|
|
||||||
.. raw:: html
|
Video
|
||||||
|
-----
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<iframe src="https://player.vimeo.com/video/213812054" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
<iframe src="https://player.vimeo.com/video/213812054" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
|
||||||
<p></p>
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
--------
|
--------
|
||||||
|
@ -7,12 +7,15 @@ Time-windows
|
|||||||
* *The notary is the timestamping authority, refusing to commit transactions outside of that window*
|
* *The notary is the timestamping authority, refusing to commit transactions outside of that window*
|
||||||
* *Time-windows can have a start and end time, or be open at either end*
|
* *Time-windows can have a start and end time, or be open at either end*
|
||||||
|
|
||||||
Video
|
.. only:: htmlmode
|
||||||
-----
|
|
||||||
.. raw:: html
|
Video
|
||||||
|
-----
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<iframe src="https://player.vimeo.com/video/213879314" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
<iframe src="https://player.vimeo.com/video/213879314" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
|
||||||
<p></p>
|
|
||||||
|
|
||||||
Time in a distributed system
|
Time in a distributed system
|
||||||
----------------------------
|
----------------------------
|
||||||
@ -38,9 +41,19 @@ For this reason, times in transactions are specified as time *windows*, not abso
|
|||||||
there can never be "true time", only an approximation of it. Time windows can be open-ended (i.e. specify only one of
|
there can never be "true time", only an approximation of it. Time windows can be open-ended (i.e. specify only one of
|
||||||
"before" and "after") or they can be fully bounded.
|
"before" and "after") or they can be fully bounded.
|
||||||
|
|
||||||
.. image:: resources/time-window.gif
|
.. only:: htmlmode
|
||||||
:scale: 25%
|
|
||||||
:align: center
|
.. image:: resources/time-window.gif
|
||||||
|
:scale: 25%
|
||||||
|
:align: center
|
||||||
|
|
||||||
|
|
||||||
|
.. only:: pdfmode
|
||||||
|
|
||||||
|
.. image:: resources/time-window.png
|
||||||
|
:scale: 25%
|
||||||
|
:align: center
|
||||||
|
|
||||||
|
|
||||||
In this way, we express the idea that the *true value* of the fact "the current time" is actually unknowable. Even when
|
In this way, we express the idea that the *true value* of the fact "the current time" is actually unknowable. Even when
|
||||||
both a before and an after time are included, the transaction could have occurred at any point within that time-window.
|
both a before and an after time are included, the transaction could have occurred at any point within that time-window.
|
||||||
|
@ -10,12 +10,15 @@ Transactions
|
|||||||
* *It is contractually valid*
|
* *It is contractually valid*
|
||||||
* *It is signed by the required parties*
|
* *It is signed by the required parties*
|
||||||
|
|
||||||
Video
|
.. only:: htmlmode
|
||||||
-----
|
|
||||||
.. raw:: html
|
Video
|
||||||
|
-----
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<iframe src="https://player.vimeo.com/video/213879807" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
||||||
|
<p></p>
|
||||||
|
|
||||||
<iframe src="https://player.vimeo.com/video/213879807" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
|
|
||||||
<p></p>
|
|
||||||
|
|
||||||
Overview
|
Overview
|
||||||
--------
|
--------
|
||||||
|
BIN
docs/source/resources/flow.png
Normal file
BIN
docs/source/resources/flow.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 134 KiB |
BIN
docs/source/resources/time-window.png
Normal file
BIN
docs/source/resources/time-window.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 72 KiB |
Loading…
Reference in New Issue
Block a user