• Re: Spinx help needed

    From c.buhtz@posteo.jp@21:1/5 to All on Thu Feb 15 09:20:02 2024
    It is always hard to follow such threads.

    It is unclear if this message is about the Sphinx package itself or a
    package that do use Sphinx in its build process.

    There are two bug numbers in the CC fields. But the mail miss links to
    the bug reports or other information giving more context.
    This makes it very hard for new contributors participating. A bit more transparency would improve the process itself and attract more
    contributors.

    Thanks in advance
    Christian

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)
  • From Dmitry Shachnev@21:1/5 to Andreas Tille on Thu Feb 15 20:00:01 2024
    On Thu, Feb 15, 2024 at 07:15:18PM +0100, Andreas Tille wrote:
    Hi Dmitry,

    thanks a lot for this hint.

    I've created a quilt patch which replaces the vendored theme by the
    sphinx13 one which is currently shipped in Debian. The patches by
    upstream seem to be void now - at least none applied to the current
    version.

    Unfortunately this does not build as well - now with other errors
    you can see in Salsa CI at

    https://salsa.debian.org/science-team/lmfit-py/-/jobs/5305535

    Do you have any further hints?

    It looks like what you did was copying layout.html to basic_layout.html
    within lmfit-py's doc/sphinx/theme/sphinx13/ directory.

    But what I suggested was copying a file from *Sphinx* source package, sphinx/themes/basic/layout.html to doc/sphinx/theme/sphinx13/basic_layout.html in lmfit-py.

    With your change basic_layout.html tried to extend itself, which caused
    a recursion error.

    I pushed a fix and the build job succeeded now. build-i386 failed, but that
    one is not related to Sphinx.

    --
    Dmitry Shachnev

    -----BEGIN PGP SIGNATURE-----

    iQIzBAABCgAdFiEEq2sdvrA0LydXHe1qsmYUtFL0RrYFAmXOXfsACgkQsmYUtFL0 RrZ9TxAAichLGrkLChvxPWR5WLXpqheiMhO9SseVEF5WlUQMS8nUj8NMcHtXpW8d INbTZl5JDFlyDHR/3BcXe063mTeVStaTX74lk5j/9vUEtU+hh0qw0YRqxLQ6JN+y 9tJYFxT14U8gV3+rdD8uA4jw+8agN8VP/EmE2xcHNdFTzyETL5ZoM1SCzNtKeSO1 QFN4Fkb2TaL8i1bBY2uGIxyoVLzomRKpYok0lDdmTvT1OLScIZFHNPrvENYx/+qz GZ+WJN5bwMxZdliYI+VRFGBOSjpGlBRhkWczv97So3VubU6oaNLxxcukFQrq/yBU WyHMuE9DoC+aUx2hWsyKxHj/6PXV3w/t9wZus9lBOoCJ8YBL7mu+kzbt/cfmQawp cehL257L5ujmT4UQ6XF9Y8CERZ63kwq0I77rTWSc89DCh//VS05YuuMW/CUiBUAp c0svmBA6WOWvORC97TAomuCLyPPgJbiErGB/E88e9yCTS3RBKWrWOwA3eA5KFlwC mZxho0DSeyEfu2czLcxj1QkDNK07R7TADvewvJVcTDSTIi1q3J4fDhTtM2CbV2Fv mG9qR2Nu4L0pF06g/xZOxkCt+VtBgP7LfcIWSUTr0Fvux9WVeWF6kZ8nU2Hjv29w jXJ2o6/bP32qrds3O6y0Et9HZ0+WxRus9bbAE6J2BGTamPckEQ4=
    =9Lls
    -----END PGP SIGNATURE-----

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)
  • From Andreas Tille@21:1/5 to All on Thu Feb 15 20:10:02 2024
    Hi Dmitry,

    thanks a lot and sorry for my naivity

    Andreas.

    Am Thu, Feb 15, 2024 at 09:54:55PM +0300 schrieb Dmitry Shachnev:
    On Thu, Feb 15, 2024 at 07:15:18PM +0100, Andreas Tille wrote:
    Hi Dmitry,

    thanks a lot for this hint.

    I've created a quilt patch which replaces the vendored theme by the sphinx13 one which is currently shipped in Debian. The patches by
    upstream seem to be void now - at least none applied to the current version.

    Unfortunately this does not build as well - now with other errors
    you can see in Salsa CI at

    https://salsa.debian.org/science-team/lmfit-py/-/jobs/5305535

    Do you have any further hints?

    It looks like what you did was copying layout.html to basic_layout.html within lmfit-py's doc/sphinx/theme/sphinx13/ directory.

    But what I suggested was copying a file from *Sphinx* source package, sphinx/themes/basic/layout.html to doc/sphinx/theme/sphinx13/basic_layout.html
    in lmfit-py.

    With your change basic_layout.html tried to extend itself, which caused
    a recursion error.

    I pushed a fix and the build job succeeded now. build-i386 failed, but that one is not related to Sphinx.

    --
    Dmitry Shachnev



    --
    http://fam-tille.de

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)
  • From Andreas Tille@21:1/5 to All on Thu Feb 15 19:20:01 2024
    Hi Dmitry,

    thanks a lot for this hint.

    Am Thu, Feb 15, 2024 at 11:46:45AM +0300 schrieb Dmitry Shachnev:
    lmfit-py ships a vendored copy of sphinx13 theme [1], which was copied from Sphinx source code with a minor modification in 2020 [2] and rebased in January 2022 [3]. However, there were more Sphinx releases since that month, and the theme needs to be updated for compatibility with them.

    I've created a quilt patch which replaces the vendored theme by the
    sphinx13 one which is currently shipped in Debian. The patches by
    upstream seem to be void now - at least none applied to the current
    version.

    Unfortunately this does not build as well - now with other errors
    you can see in Salsa CI at

    https://salsa.debian.org/science-team/lmfit-py/-/jobs/5305535

    Do you have any further hints?

    Kind regards
    Andreas.

    In particular, the basic_layout.html file misses the change which was made
    in Sphinx commit [4], without which the search will not work. There is a comment under that commit which illustrates how exactly it will not work: contentRoot will be undefined, and the browser will attempt to make requests to a URL that has "undefined" in it. dh_sphinxdoc catches such issues and produces an error about them.

    So, to fix this issue, you should copy sphinx/themes/basic/layout.html from the latest stable version of Sphinx to lmfit-py's basic_layout.html, applying the one-line change which is described in [2] and [3].

    [1]: doc/sphinx/theme/sphinx13/*
    [2]: https://github.com/lmfit/lmfit-py/commit/29e4712036606913149e16b246340a7fbedd8829
    [3]: https://github.com/lmfit/lmfit-py/commit/e2418377c9870e02c820d0fe40d2232187864a81
    [4]: https://github.com/sphinx-doc/sphinx/commit/8e730ae303ae686705ea12f44ef11da926a87cf5

    --
    Dmitry Shachnev



    --
    http://fam-tille.de

    --- SoupGate-Win32 v1.05
    * Origin: fsxNet Usenet Gateway (21:1/5)