Re: [Docutils-develop] Paths in included files

[Guenter M. <mi...@us...>]

On 2013-02-13, David Goodger wrote:
> On Wed, Feb 13, 2013 at 8:22 AM, Guenter Milde <mi...@us...> wrote:
>> Dear Docutils developers,

>> bugreport 3587443 says:

>>    Paths in included files should be relative to the directory of the
>>    included document. For the moment they are relative to the directory
>>    of the master document.

>>    -- https://sourceforge.net/tracker/?func=detail&aid=3587443&group_id=38414&atid=422030


>> However it is a change of current behaviour and a non-trivial change.

>> Do you think current behaviour is a bug or an unfortunate feature?

> I'd call it an oversight at most. Both approaches are valid, it's a
> matter of opinion. It's likely that the existing behavior is relied
> upon by some users. So I support adding support for relative paths,
> but it should be via a setting, to keep the existing behavior but
> offer the new behavior. Something like --subdocument-relative-paths /
> --master-document-relative-paths. Or maybe an option on the "include"
> directive itself.

Thinking about it and considering the other responses, I'd prefer to
change this to the proposed "relative to the directory of the included
document" (consistent for included files as well as images).

For the backwards-compatibility issue, I suggest an announcement of the
upcoming change in the RELEASE-NOTES and on the Sphinx mail list. If
there is protest, we could offer a setting for the old behaviour
(while the new is the default). This setting should itself be announced as
temporarily and removed after some time.

Günter