From a7debe115afad2c1a829ecdfca73d92be7b5fafc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marcel=20St=C3=B6r?= <marcelstoer@users.noreply.github.com>
Date: Sun, 22 Mar 2020 13:56:39 +0100
Subject: [PATCH] Add hint about locally built docs

Fixes #2868
---
 mkdocs.yml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/mkdocs.yml b/mkdocs.yml
index 64ab69fd..360b6514 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -6,6 +6,10 @@ theme:
   name: "readthedocs"
 strict: false #Allows to build and test documentation in local environment where some links are unreachable
 
+# Uncomment the line below to build docs to be used locally; site/index.html
+# will then be the root of a locally-linked documentation tree.
+# use_directory_urls: false
+
 markdown_extensions:
 #http://pythonhosted.org/Markdown/extensions/admonition.html
 - admonition: