diff --git a/MANIFEST.in b/MANIFEST.in index 3107daa6..323b54df 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -25,7 +25,8 @@ exclude tests # Exclude the documentation files recursive-exclude docs * exclude docs -recursive-include docs/source/_static/images/ lightning_logo* pl_overview* tf_* +recursive-include docs/source/_images/logos/ * +recursive-include docs/source/_images/general/ pl_overview* tf_* # Include the Requirements include requirements.txt diff --git a/README.md b/README.md index f22cfad9..314ca70d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
-![Logo](docs/source/_static/images/lightning_logo.svg) +![Logo](docs/source/_images/logos/lightning_logo.svg) # PyTorch Lightning @@ -31,9 +31,9 @@ removed until codecov badge isn't empy. likely a config error showing nothing on | :---: | :---: | :---: | :---: | :---: | | Linux py3.6 [CPU] | [![CircleCI](https://circleci.com/gh/PyTorchLightning/pytorch-lightning.svg?style=svg)](https://circleci.com/gh/PyTorchLightning/pytorch-lightning) | [![CircleCI](https://circleci.com/gh/PyTorchLightning/pytorch-lightning.svg?style=svg)](https://circleci.com/gh/PyTorchLightning/pytorch-lightning) | [![CircleCI](https://circleci.com/gh/PyTorchLightning/pytorch-lightning.svg?style=svg)](https://circleci.com/gh/PyTorchLightning/pytorch-lightning) | [![CircleCI](https://circleci.com/gh/PyTorchLightning/pytorch-lightning.svg?style=svg)](https://circleci.com/gh/PyTorchLightning/pytorch-lightning) | | Linux py3.7 [GPU] |
|
|
| [![Build Status](http://35.192.60.23/api/badges/PyTorchLightning/pytorch-lightning/status.svg)](http://35.192.60.23/PyTorchLightning/pytorch-lightning) | -| Linux py3.6 / py3.7 | ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) |
|
| ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) | -| OSX py3.6 / py3.7| ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) |
|
| ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) | -| Windows py3.6 / py3.7 | ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) |
|
| ![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push) | +| Linux py3.6 / py3.7 | [![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push)](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22CI+testing%22) |
|
| [![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push)](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22CI+testing%22) | +| OSX py3.6 / py3.7| [![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push)](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22CI+testing%22) |
|
| [![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push)](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22CI+testing%22) | +| Windows py3.6 / py3.7 | [![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push)](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22CI+testing%22) |
|
| [![CI testing](https://github.com/PyTorchLightning/pytorch-lightning/workflows/CI%20testing/badge.svg?event=push)](https://github.com/PyTorchLightning/pytorch-lightning/actions?query=workflow%3A%22CI+testing%22) | @@ -83,7 +83,7 @@ If you're just getting into deep learning, we recommend you learn PyTorch first! Everything in Blue! This is how lightning separates the science (red) from the engineering (blue). -![Overview](docs/source/_static/images/pl_overview.gif) +![Overview](docs/source/_images/general/pl_overview.gif) ## How much effort is it to convert? If your code is not a huge mess you should be able to organize it into a LightningModule in less than 1 hour. @@ -239,7 +239,7 @@ Lightning has out-of-the-box integration with the popular logging/visualizing fr - Comet.ml - ... -![tensorboard-support](docs/source/_static/images/tf_loss.png) +![tensorboard-support](docs/source/_images/general/tf_loss.png) ## Lightning automates 40+ parts of DL/ML research diff --git a/docs/source/_static/images/pl_overview.gif b/docs/source/_images/general/pl_overview.gif similarity index 100% rename from docs/source/_static/images/pl_overview.gif rename to docs/source/_images/general/pl_overview.gif diff --git a/docs/source/_static/images/pl_overview_flat.jpg b/docs/source/_images/general/pl_overview_flat.jpg similarity index 100% rename from docs/source/_static/images/pl_overview_flat.jpg rename to docs/source/_images/general/pl_overview_flat.jpg diff --git a/docs/source/_static/images/tf_loss.png b/docs/source/_images/general/tf_loss.png similarity index 100% rename from docs/source/_static/images/tf_loss.png rename to docs/source/_images/general/tf_loss.png diff --git a/docs/source/_static/images/tf_tags.png b/docs/source/_images/general/tf_tags.png similarity index 100% rename from docs/source/_static/images/tf_tags.png rename to docs/source/_images/general/tf_tags.png diff --git a/docs/source/_static/images/lightning_icon.svg b/docs/source/_images/logos/lightning_icon.svg similarity index 100% rename from docs/source/_static/images/lightning_icon.svg rename to docs/source/_images/logos/lightning_icon.svg diff --git a/docs/source/_static/images/lightning_logo-large.svg b/docs/source/_images/logos/lightning_logo-large.svg similarity index 100% rename from docs/source/_static/images/lightning_logo-large.svg rename to docs/source/_images/logos/lightning_logo-large.svg diff --git a/docs/source/_static/images/lightning_logo-name.svg b/docs/source/_images/logos/lightning_logo-name.svg similarity index 100% rename from docs/source/_static/images/lightning_logo-name.svg rename to docs/source/_images/logos/lightning_logo-name.svg diff --git a/docs/source/_static/images/lightning_logo.png b/docs/source/_images/logos/lightning_logo.png similarity index 100% rename from docs/source/_static/images/lightning_logo.png rename to docs/source/_images/logos/lightning_logo.png diff --git a/docs/source/_static/images/lightning_logo.svg b/docs/source/_images/logos/lightning_logo.svg similarity index 100% rename from docs/source/_static/images/lightning_logo.svg rename to docs/source/_images/logos/lightning_logo.svg diff --git a/docs/source/conf.py b/docs/source/conf.py index fb8724e4..19b8e7dc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -166,12 +166,12 @@ html_theme_options = { 'logo_only': False, } -html_logo = '_static/images/lightning_logo-name.svg' +html_logo = '_images/logos/lightning_logo-name.svg' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ['_images', '_templates'] # Custom sidebar templates, must be a dictionary that maps document names # to template names.