wassname/pytorch-lightning
1
0
Fork 0
mirror of https://github.com/wassname/pytorch-lightning.git synced 2026-09-09 11:32:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix failing docs (#1821)

Browse Source 
* missing pkg

* update CI

* strict RTD

* strict RTD

* make

* missing

* ignore

* ignore

* mock

* typo
This commit is contained in:
Jirka Borovec
2020-05-14 08:25:06 -04:00
committed by GitHub
parent cf2d32d0a6
commit 1c10560531
3 changed files with 25 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/conf.py
+9 -5
View File
@@ -29,7 +29,7 @@ sys.path.insert(0, os.path.abspath(PATH_ROOT))
builtins.__LIGHTNING_SETUP__ = True
IS_READTHEDOCS_BUILD = os.environ.get('READTHEDOCS', False)
SPHINX_MOCK_REQUIREMENTS = int(os.environ.get('SPHINX_MOCK_REQUIREMENTS', True))
import pytorch_lightning # noqa: E402
@@ -321,15 +321,19 @@ def package_list_from_file(file):
return mocked_packages
MOCK_PACKAGES = package_list_from_file(os.path.join(PATH_ROOT, 'requirements-extra.txt'))
if IS_READTHEDOCS_BUILD:
MOCK_PACKAGES = []
if SPHINX_MOCK_REQUIREMENTS:
# mock also base packages when we are on RTD since we don't install them there
base_packages = package_list_from_file(os.path.join(PATH_ROOT, 'requirements.txt'))
MOCK_PACKAGES.extend(base_packages)
MOCK_PACKAGES += package_list_from_file(os.path.join(PATH_ROOT, 'requirements.txt'))
MOCK_PACKAGES += package_list_from_file(os.path.join(PATH_ROOT, 'requirements-extra.txt'))
MOCK_MANUAL_PACKAGES = [
'torchvision',
'PIL',
# packages with different package name compare to import name
'yaml',
'comet_ml',
'neptune',
]
autodoc_mock_imports = MOCK_PACKAGES + MOCK_MANUAL_PACKAGES