From 6ff91cadca326b77c19222f71df6bcc4ba4e268a Mon Sep 17 00:00:00 2001 From: Mike Hearn Date: Fri, 11 May 2018 18:37:47 +0200 Subject: [PATCH] Docs: add a note to the top of the cert hierarchies design doc. Enable AutoStructify in ReCommonMark to allow rst/md to be mixed. --- docs/source/conf.py | 13 ++++++++++++- .../design/ent-1133_certificate_hierarchy/design.md | 4 ++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index e24dd0efca..b22f508600 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -13,6 +13,7 @@ # serve to show the default. import sphinx_rtd_theme +from recommonmark.transform import AutoStructify # If extensions (or modules to document with autodoc) are in another directory, @@ -47,7 +48,7 @@ source_parsers = { } # The encoding of source files. -#source_encoding = 'utf-8-sig' +source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' @@ -261,3 +262,13 @@ latex_documents = [ # If false, no module index is generated. #latex_domain_indices = True + +web_doc_root = 'https://docs.corda.net/' +def setup(app): + app.add_config_value('recommonmark_config', { + 'url_resolver': lambda url: web_doc_root + url, + 'auto_toc_tree_section': 'Contents', + 'enable_eval_rst': True, + 'enable_auto_doc_ref': False, + }, True) + app.add_transform(AutoStructify) \ No newline at end of file diff --git a/docs/source/design/ent-1133_certificate_hierarchy/design.md b/docs/source/design/ent-1133_certificate_hierarchy/design.md index 3dc1abb63d..3a02026ab0 100644 --- a/docs/source/design/ent-1133_certificate_hierarchy/design.md +++ b/docs/source/design/ent-1133_certificate_hierarchy/design.md @@ -1,5 +1,9 @@ # Certificate hierarchies +```eval_rst +.. important:: This design doc applies to the main Corda network. Other networks may use different certificate hierarchies. +``` + ## Overview A certificate hierarchy is proposed to enable effective key management in the context of managing Corda networks.