From 803ea3e65267bd22ac87af66438161d71387fe88 Mon Sep 17 00:00:00 2001 From: ben Date: Thu, 21 Mar 2019 18:07:56 +0000 Subject: [PATCH] changing substitution mechanism so that it can work with code blocks --- docs/source/app-upgrade-notes.rst | 2 +- docs/source/conf.py | 28 +++++++++++++++++----------- 2 files changed, 18 insertions(+), 12 deletions(-) diff --git a/docs/source/app-upgrade-notes.rst b/docs/source/app-upgrade-notes.rst index 67b714c1e9..e127e2f14d 100644 --- a/docs/source/app-upgrade-notes.rst +++ b/docs/source/app-upgrade-notes.rst @@ -37,7 +37,7 @@ Step 2. Adjust the version numbers in your Gradle build files Alter the versions you depend on in your Gradle file like so: -.. parsed-literal:: +.. code:: groovy ext.corda_release_version = '|corda_version|' ext.corda_gradle_plugins_version = '|gradle_plugins_version|' diff --git a/docs/source/conf.py b/docs/source/conf.py index 95e9626abb..df13b03aca 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -11,17 +11,23 @@ with open("../../constants.properties", "r") as f: constants_properties_lines = f.readlines() constants_properties_dict = dict([l.strip().split('=') for l in constants_properties_lines if not l.startswith("#") and not l.strip() == ""]) -rst_epilog = """ -.. |java_version| replace:: 8u%s -.. |kotlin_version| replace:: %s -.. |gradle_plugins_version| replace:: %s -.. |quasar_version| replace:: %s -.. |corda_version| replace:: %s -""" % (constants_properties_dict["java8MinUpdateVersion"], - constants_properties_dict["kotlinVersion"], - constants_properties_dict["gradlePluginsVersion"], - constants_properties_dict["quasarVersion"], - constants_properties_dict["cordaVersion"]) +def cordaSourceReadReplace(app, docname, source): + result = source[0] + for key in app.config.corda_substitutions: + result = result.replace(key, app.config.corda_substitutions[key]) + source[0] = result + +corda_substitutions = { + "|corda_version|" : constants_properties_dict["cordaVersion"], + "|java_version|" : "8u"+constants_properties_dict["java8MinUpdateVersion"], + "|kotlin_version|" : constants_properties_dict["kotlinVersion"], + "|gradle_plugins_version|" : constants_properties_dict["gradlePluginsVersion"], + "|quasar_version|" : constants_properties_dict["quasarVersion"] +} + +def setup(app): + app.add_config_value('corda_substitutions', {}, True) + app.connect('source-read', cordaSourceReadReplace) ############################################################################