Skip to content

Add ability to warn about pages existing in the docs directory but not included in the "nav" configuration #1755

@tjanez

Description

@tjanez

Use case

A team uses a CI system and would like to ensure documentation quality never regresses.
To this end, the CI job has a step that runs mkdocs build --strict which reports a failure if building the documentation results in any warnings or errors.

However, it can still happen that someone will write new documentation but forget to include it in the nav configuration. And MkDocs will detect this and report it. Here is an example output:

INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
  - README.md
  - foo.md

Feature request

Would it be possible to configure this INFO message to be a WARNING?

As a bonus, would it be possible to configure which files in the docs directory should be ignored by MkDocs completely?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions