Sphinx builds failing from week of Feb 15-19

4 views
Skip to first unread message

Ron Stone

unread,
Feb 22, 2021, 8:50:40 AM2/22/21
to sphinx-dev
Hi,

I have a sphinx build that stopped working last week in a Jenkins/Tox environment that runs nightly regression builds. The environment is set up from scratch each time, so any changes to python/sphinx releases are reflected immediately. 

The build relies on some rst and image content being symlinked in under source/. The particular error that sphinx is now failing on relates to an image in a symlinked directory that is a sibling of the directory where the rst file using it is, so:

.. image:: ../deploy_install_guides/r5_release/figures/deployment-options-controller-storage.png

When the folder deploy_install_guides/r5_release/figures is symlinked into source/, this results in the following

copying images... [ 11%] deploy/../deploy_install_guides/r5_release/figures/deployment-options-controller-storage.png

where the path does not appear to be constructed properly.

But if the directive is changes so the path is relative to the root, it works:
.. image:: /deploy_install_guides/r5_release/figures/deployment-options-controller-storage.png

copying images... [ 11%] /deploy_install_guides/r5_release/figures/deployment-options-controller-storage.png

It also seems to work as a relative path if the target is copied rather than symlinked in.

Has there been a change in the way sphinx constructs ../paths that transverse symlinks? The release of 3.5.1 on Feb16 coincides with the emergence of this error. 

Many thanks.

jfbu

unread,
Feb 22, 2021, 11:05:20 AM2/22/21
to sphin...@googlegroups.com
Hi,

I tried with

.. image:: /TempDir/more.png

.. image:: ../TempDir/more.png

.. image:: ./TempDir/more.png

.. image:: TempDir/more.png


and all four work for me (make html) with 3.5.1 (and 2.0.1)

where as per your description TempDir is a sibling
directory which has been symlinked into the source
directory

Note sure what your issue's cause can be
Jean-François

Reply all
Reply to author
Forward
0 new messages