[lxc-devel] [lxd/master] doc: Add configuration for readthedocs

[tenforward on Github]

A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 741 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20180929/1a37be3b/attachment.bin>
-------------- next part --------------
From f99d0d2b165b73588189bda202d9516c6027f07a Mon Sep 17 00:00:00 2001
From: KATOH Yasufumi <karma at jazz.email.ne.jp>
Date: Sat, 29 Sep 2018 18:28:08 +0900
Subject: [PATCH] doc: Add configuration for readthedocs

The documentation of LXD is converted and published on readthedocs.org.
In this conversion, mkdocs is used. When this conversion, mkdocs uses
"mkdocs" theme by default.

With the mkdocs theme, the menu at the top of each page is too large,
and contents of a page will be hidden.

So add mkdocs.yml, and set it to use the "readthedocs" theme. Current
configuration is minium.

Signed-off-by: KATOH Yasufumi <karma at jazz.email.ne.jp>
---
 mkdocs.yml | 2 ++
 1 file changed, 2 insertions(+)
 create mode 100644 mkdocs.yml

diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000000..0809fca9d6
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,2 @@
+site_name: "LXD - system container manager"
+theme: readthedocs