ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-24 07:06:44 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Docs: introduce a java_version substitution

Browse Source
This commit is contained in:
Mike Hearn 2019-02-20 20:37:58 +01:00
parent 4afa28bc77
commit f932fa591d
3 changed files with 15 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/source/conf.py
View File

@ -1,20 +1,19 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
#
# R3 prototyping documentation build configuration file, created by
# sphinx-quickstart on Mon Nov 23 21:19:35 2015.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sphinx_rtd_theme import sphinx_rtd_theme
import sys, os import sys, os
############################################################################
#
# TEXT SUBSTITUTIONS
rst_epilog = """
.. |java_version| replace:: 8u171
.. |kotlin_version| replace:: 1.2.71
"""
############################################################################
sys.path.append(os.path.abspath('../ext/')) sys.path.append(os.path.abspath('../ext/'))
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
@ -66,15 +65,6 @@ release = 'Master'
# The version for use in the dropdown html. # The version for use in the dropdown html.
html_context = {'version': 'Master'} html_context = {'version': 'Master'}
# Properties.
kotlin_version = '1.2.71'
rst_epilog = """
.. |kotlin_version| replace:: {kotlin_version}
""".format(
kotlin_version = kotlin_version,
)
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
# #

4
docs/source/getting-set-up.rst
View File

@ -5,7 +5,7 @@ Software requirements
--------------------- ---------------------
Corda uses industry-standard tools: Corda uses industry-standard tools:
* **Oracle JDK 8 JVM** - minimum supported version **8u171** * **Oracle JDK 8 JVM** - minimum supported version **|java_version|** (please note that
* **IntelliJ IDEA** - supported versions **2017.x** and **2018.x** (with Kotlin plugin version |kotlin_version|) * **IntelliJ IDEA** - supported versions **2017.x** and **2018.x** (with Kotlin plugin version |kotlin_version|)
* **Git** * **Git**
@ -26,7 +26,7 @@ Please note:
`getting started guide <https://kotlinlang.org/docs/tutorials/>`_, and a series of `getting started guide <https://kotlinlang.org/docs/tutorials/>`_, and a series of
`Kotlin Koans <https://kotlinlang.org/docs/tutorials/koans.html>`_ `Kotlin Koans <https://kotlinlang.org/docs/tutorials/koans.html>`_
* IntelliJ IDEA is recommended due to the strength of its Kotlin integration * IntelliJ IDEA is recommended due to the strength of its Kotlin integration.
Following these software recommendations will minimize the number of errors you encounter, and make it easier for Following these software recommendations will minimize the number of errors you encounter, and make it easier for
others to provide support. However, if you do use other tools, we'd be interested to hear about any issues that arise. others to provide support. However, if you do use other tools, we'd be interested to hear about any issues that arise.

4
docs/source/release-notes.rst
View File

@ -211,9 +211,9 @@ version requirement if they start using new features and APIs.
Dependency upgrades Dependency upgrades
+++++++++++++++++++ +++++++++++++++++++
We've raised the minimum JDK to 8u171, needed to get fixes for certain ZIP compression bugs. We've raised the minimum JDK to |java_version|, needed to get fixes for certain ZIP compression bugs.
We've upgraded to Kotlin 1.2.71 so your apps can now benefit from the new features in this language release. We've upgraded to Kotlin |kotlin_version| so your apps can now benefit from the new features in this language release.
We've upgraded to Gradle 4.10.1. We've upgraded to Gradle 4.10.1.