From 94ba3303c0f3e9de40561dfed79ab2169967d01d Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Mon, 10 Jan 2022 11:04:54 -0500 Subject: [PATCH 1/7] Add virtual environment configuration --- configure_venv.bat | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 configure_venv.bat diff --git a/configure_venv.bat b/configure_venv.bat new file mode 100644 index 000000000..903d19013 --- /dev/null +++ b/configure_venv.bat @@ -0,0 +1,7 @@ +@echo off +setlocal + +python -m venv venv +pip install -r requirements_docs.txt +pip install -r requirements_style.txt +venv\Scripts\activate.bat From 39b3d2bcafed6d5333e5327f4ea0462192d58601 Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Mon, 10 Jan 2022 11:05:23 -0500 Subject: [PATCH 2/7] Lowercase formatting for commands, don't pollute calling environment --- doc/make.bat | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/make.bat b/doc/make.bat index 6247f7e23..64e24d2ab 100644 --- a/doc/make.bat +++ b/doc/make.bat @@ -1,4 +1,5 @@ -@ECHO OFF +@echo off +setlocal pushd %~dp0 From ba9428eef7b1f0ea44e9e904f767ff6156bb8ea5 Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Mon, 10 Jan 2022 11:37:08 -0500 Subject: [PATCH 3/7] Add note about virtual environment configuration --- README.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index ebab2254d..5861e4d57 100644 --- a/README.rst +++ b/README.rst @@ -18,13 +18,20 @@ A PDF version of this guide can be found in the release notes in `Releases Generate Documentation ---------------------- -To generate this documentation locally, first install the -requirements with: +To generate this documentation locally, you can install the requirements into +your Python environment with: .. code:: pip install -r requirements_docs.txt +or if you want to configure and activate Python virtual environment with the +required packages: + +.. code:: + + configure_venv + Then, depending on your operating system, generate the documentation. On Windows, generate with: From ff1027312c94a99bd25eeea9fb88a0474f9f175c Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Mon, 10 Jan 2022 11:38:08 -0500 Subject: [PATCH 4/7] Add unix/linux virtual environment configuration --- configure_venv.sh | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 configure_venv.sh diff --git a/configure_venv.sh b/configure_venv.sh new file mode 100644 index 000000000..916dfe104 --- /dev/null +++ b/configure_venv.sh @@ -0,0 +1,6 @@ +#!/bin/sh + +python -m venv venv +pip install -r requirements_docs.txt +pip install -r requirements_style.txt +venv/activate From 4495567d576d28e8914896c37684761f7b236caa Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Mon, 10 Jan 2022 11:38:34 -0500 Subject: [PATCH 5/7] Auto detect file types except for .sh and .bat files --- .gitattributes | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..41478a022 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ +* text=auto !eol +*.sh eol=lf +*.bat eol=crlf \ No newline at end of file From 23b3fb25f0a85cf3d87d89f2777c198718b4d39c Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Mon, 10 Jan 2022 11:40:29 -0500 Subject: [PATCH 6/7] Fix grammar. --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 5861e4d57..8656e4b47 100644 --- a/README.rst +++ b/README.rst @@ -25,7 +25,7 @@ your Python environment with: pip install -r requirements_docs.txt -or if you want to configure and activate Python virtual environment with the +or if you want to configure and activate a Python virtual environment with the required packages: .. code:: From f821a7a3a0ef879d89f0d1b4ade3be5a7eb94134 Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Mon, 10 Jan 2022 12:17:42 -0500 Subject: [PATCH 7/7] Ignore visual studio code workspace config --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 8b11f3df6..17ea3705f 100644 --- a/.gitignore +++ b/.gitignore @@ -12,6 +12,7 @@ dist/* build/* doc/build/ +.vscode/ # virtual environment venv/ \ No newline at end of file