Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* text=auto !eol
*.sh eol=lf
*.bat eol=crlf
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ dist/*

build/*
doc/build/
.vscode/

# virtual environment
venv/
11 changes: 9 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 a Python virtual environment with the
required packages:

.. code::

configure_venv

Then, depending on your operating system, generate the documentation.

On Windows, generate with:
Expand Down
7 changes: 7 additions & 0 deletions configure_venv.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
@echo off
setlocal
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dnwillia-ansys Out of curiosity, why do we need to use setlocal here as we don't define any variable?

Copy link
Contributor Author

@dnwillia-work dnwillia-work Jan 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's technically not needed here. Force of habit from my side. I can remove it if you feel it should not be there.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's fine by me. Thanks Dan.


python -m venv venv
pip install -r requirements_docs.txt
pip install -r requirements_style.txt
venv\Scripts\activate.bat
6 changes: 6 additions & 0 deletions configure_venv.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/bin/sh

python -m venv venv
pip install -r requirements_docs.txt
pip install -r requirements_style.txt
venv/activate
3 changes: 2 additions & 1 deletion doc/make.bat
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
@ECHO OFF
@echo off
setlocal

pushd %~dp0

Expand Down