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

diff --git a/.gitignore b/.gitignore
index b005fab38cd36c45d48ac8e82ff7393229528e63..1f4efb65aff5188fd4ceb6e599ef7258f3635340 100644 (file)
--- 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 ef77f6bfe2ff14b624420c286725e96418b004d2..41947d9f8f99453d709a5e0e9a23fb2206087e89 100644 (file)
--- 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'