Allow docname to be None in source-read event

[mgeier]

I don't know why that happens, but it seems to happen since Sphinx 7.2, most likely since sphinx-doc/sphinx#11510.

This has also been reported in sphinx-doc/sphinx#11620, but it has been closed.

[mgeier]

I have created sphinx-doc/sphinx#11648 with some more information.

[mgeier]

This is obsolete if #60 is merged.

[lucyleeow]

The None could be caused by the same reason as in Sphinx Gallery: sphinx-gallery/sphinx-gallery#1175 (comment) (file suffix not contained within app.config.source_suffix).

[mgeier]

Thanks @lucyleeow! Yes, it looks like it. But I don't see a reason why a file included with the include directive should be required to have one of the suffixes from source_suffix. Is this documented anywhere?

Anyway, it's not a big deal, I can easily check for None and work around this problem.

[lucyleeow]

Yes documentation could be improved. AFAICT its due to this part in path2doc which has always been in that function:
https://github.com/sphinx-doc/sphinx/blob/5e88b9f88665dd8782b9feb381b499ae580cfa1a/sphinx/project.py#L91

So just their definition of docname?

[mgeier]

As I understand it (which might be wrong), the term "document" means that it is part of the TOC (or as special case an "orphaned" document), but something included by the include directive is not necessarily a "document". Does that make sense?

If that's true, I think the path2doc is fine if it checks source_suffix, because it is about a "document". However, the source-read even is not only called for "documents" (since Sphinx 7.2). I think the documentation of the source-read event should be updated.

[mgeier]

Obsoleted by #61.