From 3fd1fe388ee5c7bfe4680ec4584ca7a2d4fa41ce Mon Sep 17 00:00:00 2001
From: Boyan Karatotev <boyan.karatotev@arm.com>
Date: Thu, 27 Oct 2022 11:28:23 +0100
Subject: [PATCH] fix(docs): prevent a virtual environment from failing a build

sphinx-build is passed a blanket "." to build all docs. However, if a
virtual environment is placed within the docs directory, sphinx will try
to build it which will fail due to some weird files it has.

This excludes the most common virtual environment directories from the
build to prevent this.

Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com>
Change-Id: Ieeb14cfc5730d21c986611feb0ed379c58dfcae2
---
 .gitignore   | 6 ++++++
 docs/conf.py | 3 ++-
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/.gitignore b/.gitignore
index b005fab38..1f4efb65a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -43,3 +43,9 @@ tags
 
 # Node.js
 node_modules/
+
+# common python virtual environment directories
+.env/
+env/
+.venv/
+venv/
diff --git a/docs/conf.py b/docs/conf.py
index ef77f6bfe..41947d9f8 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -41,7 +41,8 @@ language = None
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path .
-exclude_patterns = []
+# Don't try to build the venv in case it's placed with the sources
+exclude_patterns = [".env", "env", ".venv", "venv"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'