Skip to content

Commit d40c94f

Browse files
edenlightningBorda
authored andcommitted
docs index update (#17780)
Co-authored-by: Jirka <[email protected]> (cherry picked from commit 049f6c5)
1 parent b33ec56 commit d40c94f

File tree

4 files changed

+21
-31
lines changed

4 files changed

+21
-31
lines changed

docs/source-pytorch/index.rst

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -147,10 +147,10 @@ Current Lightning Users
147147
.. toctree::
148148
:maxdepth: 1
149149
:name: start
150-
:caption: Get Started
150+
:caption: Home
151151

152152
starter/introduction
153-
starter/installation
153+
Install <starter/installation>
154154
upgrade/migration_guide
155155

156156

@@ -179,21 +179,13 @@ Current Lightning Users
179179

180180
api_references
181181

182-
.. toctree::
183-
:maxdepth: 1
184-
:name: Examples
185-
:caption: Examples
186-
:glob:
187-
188-
notebooks/**/*
189-
190-
191182
.. toctree::
192183
:maxdepth: 1
193184
:name: More
194185
:caption: More
195186

196187
Community <community/index>
188+
Examples <tutorials>
197189
Glossary <glossary/index>
198190
How to <common/index>
199191

docs/source-pytorch/notebooks.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
:orphan:
2+
3+
PyTorch Lightning Tutorials
4+
===========================
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
:name: Notebooks
9+
:caption: Notebooks
10+
:glob:
11+
12+
notebooks/**/*

docs/source-pytorch/starter/installation.rst

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,6 @@
66
Installation
77
############
88

9-
10-
11-
*****************************
12-
Apple Silicon (M1/M2/M3) Macs
13-
*****************************
14-
While ML related python packages are updated to work with Apple Silicon, you'll need to set 2 environment variables on install.
15-
16-
.. code-block:: bash
17-
18-
# needed for M1/M2/M3
19-
export GRPC_PYTHON_BUILD_SYSTEM_OPENSSL=1
20-
export GRPC_PYTHON_BUILD_SYSTEM_ZLIB=1
21-
22-
python -m pip install -U lightning
23-
24-
25-
----
26-
279
****************
2810
Install with pip
2911
****************
@@ -56,6 +38,12 @@ You can also use `Conda Environments <https://docs.conda.io/projects/conda/en/la
5638
5739
----
5840

41+
42+
In case you face difficulty with pulling the GRPC package, please follow this `thread <https://stackoverflow.com/questions/66640705/how-can-i-install-grpcio-on-an-apple-m1-silicon-laptop>`_
43+
44+
45+
----
46+
5947
*****************
6048
Build from Source
6149
*****************

docs/source-pytorch/tutorials.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
:orphan:
2-
31
PyTorch Lightning Tutorials
42
===========================
53

0 commit comments

Comments
 (0)