Provide a better error message if the master document is not included in project documents #11873

[Lynn-Hu-D]

Subject: Provide a better error message if the master document is not included in project documents [#11873]

Feature or Bugfix

• Bugfix
• Refactoring

Purpose

• Provide a better error message if the master document is not included in project documents

Detail

Three cases if the master document (index.rst) is not found.

• Case 1: The master document is included in the exclude_patterns
• Case 2: The include_patterns is set, but the master document is not included in the include_patterns
• Case 3: The master document does not exist in the project t document.

Relates

[picnixz]

Please add some tests (or I'll do it myself this w-e since this might be a bit difficult) and a CHANGES entry.

[picnixz]

Sorry, I totally forgot about that PR and since I am travelling I won't be able to add the tests. I'll do it in 10 days or so but thank you for your work for now!

[Lynn-Hu-D]

Sorry, I totally forgot about that PR and since I am travelling I won't be able to add the tests. I'll do it in 10 days or so but thank you for your work for now!

[Lynn-Hu-D]

Hello,
I didn't intend to close the issue; it was an accident. What steps should I take now to have this PR merged?

[picnixz]

I didn't intend to close the issue; it was an accident. What steps should I take now to have this PR merged?

You should add a test for that. Do you want some help? (I will be busy until... the end of the week but ping me next week if I forgot about it).