BuildEnvironment.docname can now be None

[AA-Turner]

It seems that BuildEnvironment.docname can now be None:

sphinx/sphinx/environment/__init__.py

Line 545 in ed84d63

def docname(self) -> str:

or at least env.docname in read-source event can now be None:

sphinx/sphinx/io.py

Line 114 in da9f8a5

env.events.emit('source-read', env.docname, arg)

Ref: sphinx-gallery/sphinx-gallery#1175

Originally posted by @lucyleeow in #11605 (comment)

[AA-Turner]

@lucyleeow thanks for this report, do you have a reproducer for this at all please?

Thanks,
Adam

[AA-Turner]

May be related to #10678 & #11510

[AA-Turner]

Not a bug in Sphinx, will report upstream (sphinx-gallery/sphinx-gallery#1175)

[lucyleeow]

Thank you @AA-Turner for looking into this!

Would it be appropriate to update the docs so docname return type is str or None.? Though I do note that path2doc has always had return type str or None, so this is not a new change.

[mgeier]

I seem to have the same problem in my sphinx-last-updated-by-git extension. I can work around it with mgeier/sphinx-last-updated-by-git#59, but I'm not sure if that's the right thing to do.

I think at least the source-read docs should be updated to explain in which situations docname can be None.

[mgeier]

I have added a reproducer: #11648

We can continue discussion there.

[AA-Turner]

Closing as fixed by #11657.