From 892f7cab1d2ac58383991fbc3552318546a4459f Mon Sep 17 00:00:00 2001 From: Iain Learmonth Date: Fri, 8 Apr 2022 13:11:05 +0100 Subject: [PATCH] Document configuration file somewhat --- docs/admin/conf.rst | 6 ++++++ docs/index.rst | 1 + 2 files changed, 7 insertions(+) create mode 100644 docs/admin/conf.rst diff --git a/docs/admin/conf.rst b/docs/admin/conf.rst new file mode 100644 index 0000000..2509e2c --- /dev/null +++ b/docs/admin/conf.rst @@ -0,0 +1,6 @@ +Configuration File +================== + +A file named ``config.yaml`` must exist. For each provider in use, credentials must be added. + +.. literalinclude:: ../../config.yaml.example diff --git a/docs/index.rst b/docs/index.rst index 8b66bc6..5cf16f3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,6 +17,7 @@ Documentation Home :caption: Admin Guide: admin/index.rst + admin/conf.rst .. toctree:: :maxdepth: 2