docs index update (#17780)

Co-authored-by: Jirka <jirka.borovec@seznam.cz>
This commit is contained in:
edenlightning 2023-06-21 12:04:06 -04:00 committed by GitHub
parent 287bdebaa6
commit 049f6c576a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 21 additions and 31 deletions

View File

@ -147,10 +147,10 @@ Current Lightning Users
.. toctree::
:maxdepth: 1
:name: start
:caption: Get Started
:caption: Home
starter/introduction
starter/installation
Install <starter/installation>
upgrade/migration_guide
@ -179,21 +179,13 @@ Current Lightning Users
api_references
.. toctree::
:maxdepth: 1
:name: Examples
:caption: Examples
:glob:
notebooks/**/*
.. toctree::
:maxdepth: 1
:name: More
:caption: More
Community <community/index>
Examples <tutorials>
Glossary <glossary/index>
How to <common/index>

View File

@ -0,0 +1,12 @@
:orphan:
PyTorch Lightning Tutorials
===========================
.. toctree::
:maxdepth: 1
:name: Notebooks
:caption: Notebooks
:glob:
notebooks/**/*

View File

@ -6,24 +6,6 @@
Installation
############
*****************************
Apple Silicon (M1/M2/M3) Macs
*****************************
While ML related python packages are updated to work with Apple Silicon, you'll need to set 2 environment variables on install.
.. code-block:: bash
# needed for M1/M2/M3
export GRPC_PYTHON_BUILD_SYSTEM_OPENSSL=1
export GRPC_PYTHON_BUILD_SYSTEM_ZLIB=1
python -m pip install -U lightning
----
****************
Install with pip
****************
@ -56,6 +38,12 @@ You can also use `Conda Environments <https://docs.conda.io/projects/conda/en/la
----
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>`_
----
*****************
Build from Source
*****************

View File

@ -1,5 +1,3 @@
:orphan:
PyTorch Lightning Tutorials
===========================