From 525d75bd2dce79fa275843cf3edfd60dbd8fd07d Mon Sep 17 00:00:00 2001 From: Alex Marshall Date: Wed, 21 Jul 2021 16:53:16 +0100 Subject: [PATCH] docs: add mkdocs setup Signed-off-by: Alex Marshall --- .gitignore | 3 +++ .readthedocs.yaml | 9 +++++++++ docs/index.md | 1 + mkdocs.yml | 4 ++++ 4 files changed, 17 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.gitignore b/.gitignore index d3bb742e..5d971153 100644 --- a/.gitignore +++ b/.gitignore @@ -37,3 +37,6 @@ build pom.xml.versionsBackup markers + +# MkDocs documentation +site/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..1e3727cc --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,9 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +mkdocs: + configuration: mkdocs.yml diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..dbf11d4e --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +# Daml on QLDB diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..aafa4c20 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,4 @@ +site_name: Daml on QLDB +site_author: BTP +theme: readthedocs +copyright: Copyright © 2021 Blockchain Technology Partners