Rooba
/
lightning
mirror of https://github.com/Lightning-AI/lightning.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
lightning/requirements/docs.txt

13 lines
287 B
Plaintext
Raw Normal View History

Pin sphinx version (fix for current docs build errors) (#1382) * Update requirements.txt * Update docs/requirements.txt Co-Authored-By: Jirka Borovec <Borda@users.noreply.github.com> * freeze sphinx version * Update docs/source/conf.py Co-Authored-By: Adrian Wälchli <aedu.waelchli@gmail.com> Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com> Co-authored-by: J. Borovec <jirka.borovec@seznam.cz>
2020-04-06 06:42:33 +00:00
sphinx>=2.0, <3.0
Sphinx generated documentation (#521) * 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
2019-11-28 17:48:55 +00:00
recommonmark # fails with badges
m2r # fails with multi-line text
nbsphinx
pandoc
docutils
sphinxcontrib-fulltoc
doc reqs
2020-01-21 21:53:33 +00:00
sphinxcontrib-mockautodoc
update Docs [links & formatting] (#769) * wip * wip * debug imports docs formatting * WIP * formatting * fix setup
2020-02-09 22:39:10 +00:00
git+https://github.com/PytorchLightning/lightning_sphinx_theme.git
Type Hints for Trainer (#912) * typehints for trainer fix type links in docs fix types in docs type hints for trainer methods fix fit docs switch to comments readability added sphinx typehints extension wip remove typehints from docstring more type annotations fix spaces * Update trainer.py Co-authored-by: William Falcon <waf2107@columbia.edu>
2020-02-23 02:23:30 +00:00
# pip_shims
CI: Force docs warnings to be raised as errors (+ fix all) (#1191) * add argument to force warn * fix automodule error * fix permalink error * fix indentation warning * fix warning * fix import warnings * fix duplicate label warning * fix bullet point indentation warning * fix duplicate label warning * fix "import not top level" warning * line too long * fix indentation * fix bullet points indentation warning * fix hooks warnings * fix reference problem with excluded test_tube * fix indentation in print * change imports for trains logger * remove pandas type annotation * Update pytorch_lightning/core/lightning.py * include bullet points inside note * remove old quick start guide (unused) * fix unused warning * fix formatting * fix duplicate label issue * fix duplicate label warning (replaced by class ref) * fix tick * fix indentation warnings * docstring ticks * remove obsolete docstring typing * Revert "remove old quick start guide (unused)" This reverts commit d51bb40695442c8fa11bc9df74f6db56264f7509. * added old quick start guide to navigation * remove unused tutorials file * ignore some modules that got deprecated and are not used anymore * fix duplicate label warning * move examples doc and exclude pl_examples from autodoc * fix formatting for configure_optimizer * fix no blank line warnings * fix "see also" labels and add paramref extension * fix more reference problems * fix multi-gpu reference * fix weird warning * fix indentation and unrecognized characters in code block * fix warning "... not included in toctree" * fix PIL import error * fix duplicate target "here" warning * fix broken link * revert accidentally moved pl_examples * changelog * stdout * note some things to know Co-Authored-By: Jirka Borovec <Borda@users.noreply.github.com> Co-authored-by: J. Borovec <jirka.borovec@seznam.cz> Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
2020-03-20 19:49:01 +00:00
sphinx-autodoc-typehints
Temporary Fix for docs build failure (#1413) * Update requirements.txt * fix SG typo Co-authored-by: J. Borovec <jirka.borovec@seznam.cz>
2020-04-08 12:18:36 +00:00
sphinx-paramlinks<0.4.0