Skip to content

Commit cce4207

Browse files
authored
Docs: Clarify that Windows is not supported; fix Sphinx build (horovod#3377)
Signed-off-by: Max H. Gerlach <[email protected]>
1 parent 15a6aa3 commit cce4207

File tree

4 files changed

+6
-2
lines changed

4 files changed

+6
-2
lines changed

README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ scale.
115115

116116
Install
117117
-------
118-
To install Horovod:
118+
To install Horovod on Linux or macOS:
119119

120120
1. Install `CMake <https://cmake.org/install/>`__
121121

docs/install.rst

+3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Horovod Installation Guide
66
Requirements
77
------------
88

9+
- GNU Linux or macOS
910
- Python >= 3.6
1011
- `g++-5` or above, or another compiler supporting C++14
1112
- CMake 3.13 or newer
@@ -19,6 +20,8 @@ For best performance on GPU:
1920
If Horovod in unable to find the CMake binary, you may need to set ``HOROVOD_CMAKE`` in your environment before
2021
installing.
2122

23+
Horovod does not support Windows.
24+
2225
Frameworks
2326
----------
2427

docs/mocks.py

+1
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ def _dummy():
3838
'psutil',
3939

4040
'fsspec',
41+
'fsspec.callbacks',
4142
'fsspec.core',
4243
'fsspec.utils',
4344

docs/summary.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ scale.
107107

108108
Install
109109
-------
110-
To install Horovod:
110+
To install Horovod on Linux or macOS:
111111

112112
1. Install `CMake <https://cmake.org/install/>`__
113113

0 commit comments

Comments
 (0)