Skip to content

Commit 1eb0adc

Browse files
fix example repo URL; add server release requirement in doc (#113)
Co-authored-by: pyansys-ci-bot <[email protected]>
1 parent 69dfeb8 commit 1eb0adc

File tree

6 files changed

+6
-5
lines changed

6 files changed

+6
-5
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
fix example repo URL; add server release requirement in doc

doc/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@
135135
linkcheck_ignore = [
136136
"https://github.com/ansys/pyworkbench-examples",
137137
"https://github.com/ansys/pyworkbench/issues",
138-
"https://github.com/ansys/example-data/tree/master/pyworkbench",
138+
"https://github.com/ansys/example-data/raw/master/pyworkbench",
139139
"https://workbench.docs.pyansys.com",
140140
"workbench.docs.pyansys.com",
141141
"https://www.ansys.com/*",

doc/source/getting-started.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Getting started
22
###############
33

44
To run PyWorkbench, you must have a licensed copy of `Workbench
5-
<https://www.ansys.com/products/ansys-workbench>`_.
5+
<https://www.ansys.com/products/ansys-workbench>`_ of release 24.2 or above.
66

77
.. grid:: 2
88

doc/source/user-guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ This client script downloads all files with ``.out`` extensions from the server'
151151
wb.download_file("*.out")
152152
153153
There is a special client method to upload a data file from the Ansys
154-
`example-data <https://github.com/ansys/example-data/tree/master/pyworkbench>`_ repository
154+
`example-data <https://github.com/ansys/example-data/raw/master/pyworkbench>`_ repository
155155
directly to the Workbench server. You should specify the file path relative to the
156156
``pyworkbench`` folder in the ``example-data`` repository:
157157

src/ansys/workbench/core/example_data.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ def _get_file_url(relative_file_path): # noqa: N805
4646
str
4747
URL of the file in the ``example-data`` repository.
4848
"""
49-
return f"https://github.com/ansys/example-data/tree/master/pyworkbench/{relative_file_path}"
49+
return f"https://github.com/ansys/example-data/raw/master/pyworkbench/{relative_file_path}"
5050

5151
def __retrieve_file(url, local_file_path): # noqa: N805
5252
"""Download the file from the URL.

tests/test_example_data.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ def test_get_file_url(example_data):
4343
"""Test get_file_url."""
4444
relative_path, asset_file = example_data
4545
url = ExampleData._get_file_url(relative_file_path=relative_path)
46-
assert url == f"https://github.com/ansys/example-data/tree/master/pyworkbench/{relative_path}"
46+
assert url == f"https://github.com/ansys/example-data/raw/master/pyworkbench/{relative_path}"
4747

4848

4949
def test_download(example_data):

0 commit comments

Comments
 (0)