From e26c7988441d6ac5057181e40e4fe6d963f1dd4f Mon Sep 17 00:00:00 2001 From: moto <855818+mthrok@users.noreply.github.com> Date: Thu, 18 Aug 2022 10:16:53 +0900 Subject: [PATCH] Fix Sphinx-gallery display and pin sphinx-related packages --- docs/requirements-tutorials.txt | 1 - docs/requirements.txt | 17 ++++++++++++----- docs/source/_static/css/custom.css | 16 ++++++++++++++++ 3 files changed, 28 insertions(+), 6 deletions(-) diff --git a/docs/requirements-tutorials.txt b/docs/requirements-tutorials.txt index 99251c279a..c00ec02c01 100644 --- a/docs/requirements-tutorials.txt +++ b/docs/requirements-tutorials.txt @@ -5,7 +5,6 @@ cython pandas librosa sentencepiece -nbsphinx pandoc mir_eval pesq diff --git a/docs/requirements.txt b/docs/requirements.txt index 6ad0e114d7..ee39c201ed 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,11 +1,18 @@ Jinja2<3.1.0 -sphinx==3.5.4 --e git+https://github.com/pytorch/pytorch_sphinx_theme.git@b4d0005#egg=pytorch_sphinx_theme -sphinxcontrib.katex -sphinxcontrib.bibtex matplotlib pyparsing<3,>=2.0.2 -sphinx_gallery + +# Note: +# When changing Sphinx-related packages, make sure that the custom behaviors in the following +# locations are working as expected. +# - source/_templates/layout.html +# - source/_static/css/custom.css +-e git+https://github.com/pytorch/pytorch_sphinx_theme.git@b4d0005#egg=pytorch_sphinx_theme +sphinx==3.5.4 +sphinxcontrib.katex==0.8.6 +sphinxcontrib.bibtex==2.4.2 +sphinx_gallery==0.11 +nbsphinx==0.8.8 # https://github.com/bmcfee/resampy/issues/106 # Since 2022-07-07 build_docs CI job started to fail. diff --git a/docs/source/_static/css/custom.css b/docs/source/_static/css/custom.css index a70c3d54c3..d9f68fff7a 100644 --- a/docs/source/_static/css/custom.css +++ b/docs/source/_static/css/custom.css @@ -15,3 +15,19 @@ article.pytorch-article img.shield-badge { margin-top: -18px; margin-bottom: 9px; } +/* Fix for Sphinx gallery 0.11 +See https://github.com/sphinx-gallery/sphinx-gallery/issues/990 +*/ +article.pytorch-article .sphx-glr-thumbnails .sphx-glr-thumbcontainer { + width: unset; + margin-right: 0; + margin-left: 0; +} +article.pytorch-article .sphx-glr-thumbnails { + display: flex; + grid-template-columns: none; +} +article.pytorch-article .sphx-glr-thumbnails .sphx-glr-thumbnails { + display: grid; + grid-template-columns: repeat(auto-fill, minmax(160px, 1fr)); +}