Sphinx generated documentation (#521)

Browse Source

* upgrade req.

* move MkDocs

* create Sphinx

* init Sphinx

* move md from MkDocs to Sphinx

* CI: build docs

* build Sphinx

formatting

move docs from MD to docstring in particular package/modules

formatting

add Sphinx ext.

rename root_module to core

drop implicit name "_logger"

drop duplicate name "overwrite"

fix imports

use pytorch theme

add sample link mapping

try fix RTD build

use forked template

fix some docs warnings

fix paths

add deprecation warnings

fix flake8

fix paths

revert refactor

revert MLFlowLogger

* revert example import

* update link

* Update lightning_module_template.py

...

This commit is contained in:

Jirka Borovec

2019-11-28 12:48:55 -05:00

committed by William Falcon

parent 47659daa5f

commit d71556e7a1

53 changed files with 2956 additions and 2725 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

docs/source/_static/coverage.svg → docs/source/_static/images/coverage.svg

Side by Side Swipe Overlay Before Width:  |  Height:  |  Size: 901 B After Width:  |  Height:  |  Size: 901 B

docs/source/_static/lightning_logo.png → docs/source/_static/images/lightning_logo.png

Side by Side Swipe Overlay Before Width:  |  Height:  |  Size: 11 KiB After Width:  |  Height:  |  Size: 11 KiB

docs/source/_static/lightning_logo_medium.png → docs/source/_static/images/lightning_logo_medium.png

Side by Side Swipe Overlay Before Width:  |  Height:  |  Size: 8.3 KiB After Width:  |  Height:  |  Size: 8.3 KiB

docs/source/_static/lightning_logo_small.png → docs/source/_static/images/lightning_logo_small.png

Side by Side Swipe Overlay Before Width:  |  Height:  |  Size: 2.6 KiB After Width:  |  Height:  |  Size: 2.6 KiB

docs/source/_static/overview_flat.jpg → docs/source/_static/images/overview_flat.jpg

Side by Side Swipe Overlay Before Width:  |  Height:  |  Size: 410 KiB After Width:  |  Height:  |  Size: 410 KiB

docs/source/_static/tf_loss.png → docs/source/_static/images/tf_loss.png

Side by Side Swipe Overlay Before Width:  |  Height:  |  Size: 219 KiB After Width:  |  Height:  |  Size: 219 KiB

docs/source/_static/tf_tags.png → docs/source/_static/images/tf_tags.png

Side by Side Swipe Overlay Before Width:  |  Height:  |  Size: 214 KiB After Width:  |  Height:  |  Size: 214 KiB