Skip to content

Commit abbf48f

Browse files
Minor cleanup of windows build script and venv configuration (#27)
* Add virtual environment configuration * Lowercase formatting for commands, don't pollute calling environment * Add note about virtual environment configuration * Add unix/linux virtual environment configuration * Auto detect file types except for .sh and .bat files * Fix grammar. * Ignore visual studio code workspace config
1 parent c62ea54 commit abbf48f

File tree

6 files changed

+28
-3
lines changed

6 files changed

+28
-3
lines changed

.gitattributes

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
* text=auto !eol
2+
*.sh eol=lf
3+
*.bat eol=crlf

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ dist/*
1212
# Build docs and packages
1313
build/*
1414
doc/build/
15+
.vscode/
1516

1617
# virtual environment
1718
venv/

README.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,20 @@ A PDF version of this guide can be found in the release notes in `Releases
1818

1919
Generate Documentation
2020
----------------------
21-
To generate this documentation locally, first install the
22-
requirements with:
21+
To generate this documentation locally, you can install the requirements into
22+
your Python environment with:
2323

2424
.. code::
2525
2626
pip install -r requirements_docs.txt
2727
28+
or if you want to configure and activate a Python virtual environment with the
29+
required packages:
30+
31+
.. code::
32+
33+
configure_venv
34+
2835
Then, depending on your operating system, generate the documentation.
2936

3037
On Windows, generate with:

configure_venv.bat

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
@echo off
2+
setlocal
3+
4+
python -m venv venv
5+
pip install -r requirements_docs.txt
6+
pip install -r requirements_style.txt
7+
venv\Scripts\activate.bat

configure_venv.sh

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/bin/sh
2+
3+
python -m venv venv
4+
pip install -r requirements_docs.txt
5+
pip install -r requirements_style.txt
6+
venv/activate

doc/make.bat

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
@ECHO OFF
1+
@echo off
2+
setlocal
23

34
pushd %~dp0
45

0 commit comments

Comments
 (0)