Ignore results in omitted files warning

[lukasgeiter]

This still is not working for me. I have tried several variants and workarounds.
I have the files .nav.yml and .nav.de.yml in the /docs directory. Both of them include the line

ignore: old-link.md

But I still get the warning:

WARNING -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
  - old-link.md

pretix/pretix-docs#75

Originally posted by @mschrumpf in #102

[lukasgeiter]

@mschrumpf Thanks for reporting this. Currently, ignore results in an omitted_files validation. By default, this produces an info message, but in your repo it's configured to produce a warning instead.

So far I'm not entirely sure if I should suppress that message though. There is some value in mkdocs indirectly informing users that those files will be included in the site but not linked to in the navigation.

If I try to suppress the message, there are some special cases to figure out. What would you expect in the following scenario:

docs/
├─ .nav.yml
├─ getting-started.md
└─ old-link.md

ignore: old-link.md
nav:
  - getting-started.md

In this case, old-link.md would not be part of the navigation. However it's not due to the ignore. It's because nav doesn't reference it in any way. Would you expect the omitted_files message or not?

[mschrumpf]

Thanks for getting back to me on this!
I'm not entirely sure if I understand the question. Your example looks exactly like my .nav.yml file.
Your question seems to imply that ignore: old-link.md does not do anything here. Why not?

I would expect a warning or info message if I have defined a nav: section in a .nav.yml file, but have not included all files in the directory in the nav: section.

I would not expect a warning or info message if I have included one or more files under ignore:, because in that case, I explicitly told MkDocs to ignore those files, so there is no need to notify me about that.

[lukasgeiter]

In my example, nav includes neither a direct reference to old-link.md nor a glob pattern such as * that would match it. Therefore, even without ignore, old-link.md would not be included in the navigation.

[mschrumpf]

So would the nav.yml file usually look like the following?

ignore: old-link.md

nav:
 - getting-started.md
 - old-link.md

I had assumed the proper way to use ignore was to not include the page that is to be ignored under nav:.

[lukasgeiter]

No, such a .nav.yml makes no sense. You're correct in assuming that omitting a file from nav will hide it from the navigation. In that case you don't need ignore at all.

ignore comes into play when you have glob patterns (e.g. *) in your nav. A more realistic example would be:

ignore: old-link.md

nav:
 - getting-started.md
 - "*"

[mschrumpf]

I see, thanks for clearing up the confusion

[lukasgeiter]

No problem. Does this mean this issue is resolved for you?

[mschrumpf]

I guess this issue is resolved, yes. But I think there is a difference between ignoring files explicitly on purpose, and forgetting to include them in nav:. I would wish for there to be a way to set files to be ignored on purpose, even if omitted_files is set to warn