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

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>
This commit is contained in:
Adrian Wälchli 2020-04-06 08:42:33 +02:00 committed by GitHub
parent 91c9b29d47
commit 5f6be4dd53
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/requirements.txt
View File

@ -1,4 +1,4 @@
sphinx>=2.0 sphinx>=2.0, <3.0
recommonmark # fails with badges recommonmark # fails with badges
m2r # fails with multi-line text m2r # fails with multi-line text
nbsphinx nbsphinx
@ -9,4 +9,4 @@ sphinxcontrib-mockautodoc
git+https://github.com/PytorchLightning/lightning_sphinx_theme.git git+https://github.com/PytorchLightning/lightning_sphinx_theme.git
# pip_shims # pip_shims
sphinx-autodoc-typehints sphinx-autodoc-typehints
sphinx-paramlinks sphinx-paramlinks

2
docs/source/conf.py
View File

@ -66,7 +66,7 @@ release = pytorch_lightning.__version__
# If your documentation needs a minimal Sphinx version, state it here. # If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '1.4' needs_sphinx = '2.0'
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom