From 4cbf948d84c8234d596bd66a568a387edd2999a6 Mon Sep 17 00:00:00 2001 From: Martin Huschenbett Date: Tue, 19 Nov 2019 15:51:13 +0100 Subject: [PATCH] Move the docs for the visualization to the experimental section --- docs/configs/pdf/index.rst | 1 + docs/source/index.rst | 2 +- docs/source/tools/visual.rst | 8 ++++---- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/configs/pdf/index.rst b/docs/configs/pdf/index.rst index 9b6dfa8afab4..8229df233b7b 100644 --- a/docs/configs/pdf/index.rst +++ b/docs/configs/pdf/index.rst @@ -93,6 +93,7 @@ Experimental features daml-integration-kit/index json-api/index triggers/index + tools/visual Support and updates ------------------- diff --git a/docs/source/index.rst b/docs/source/index.rst index 3eb58411c3af..cc43ab4b186d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -56,7 +56,6 @@ DAML SDK documentation tools/assistant tools/sandbox - tools/visual tools/navigator/index tools/codegen @@ -99,6 +98,7 @@ DAML SDK documentation migrate/index json-api/index DAML Triggers + tools/visual .. toctree:: :titlesonly: diff --git a/docs/source/tools/visual.rst b/docs/source/tools/visual.rst index 5b6f7d2c8aad..4debe3a3f8c1 100644 --- a/docs/source/tools/visual.rst +++ b/docs/source/tools/visual.rst @@ -13,7 +13,7 @@ You can generate visual graphs for the contracts in your DAML project. To do thi Example: Visualizing the Quickstart project -******************************************* +=========================================== Here's an example visualization based on the :doc:`quickstart `. You'll need to `install Graphviz `_ to try this out. @@ -32,7 +32,7 @@ Running the above should produce an image which looks something like this: Visualizing DAML Contracts - Within IDE -####################################### +======================================= You can generate visual graphs from VS Code IDE. Open the daml project in VS Code and use `command palette `_. Should reveal a new window pane with dot image. Also visual generates only the currently open daml file and its imports. @@ -40,7 +40,7 @@ Note: You will need to install the Graphviz/dot packages as mentioned above. Visualizing DAML Contracts - Interactive Graphs -############################################### +=============================================== This does not require any packages installed. You can generate `D3 `_ graphs for the contracts in your DAML project. To do this @@ -52,4 +52,4 @@ Running the above should produce an image which looks something like this: .. image:: images/d3-visual.png :width: 30% - :align: center \ No newline at end of file + :align: center