Skip to content

Enable users to change log level #2876

@AngryMane

Description

@AngryMane

Proposal/Request

I want to add an option for users to set their own logging level like below.

mkdocs -l WARN build 

We can implement this like this.

Background

See this repo.
This mkdocs project includes many files that should not be registered to nav, and one broken link,

If you build this repo by mkdocs build, then you see the following log.

$ mkdocs build
INFO     -  Cleaning site directory
INFO     -  Building documentation to directory: /home/username/work/git/sample-mkdocs-prj/site
INFO     -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
              - file_not_registered_to_nav.md
              - file_not_registered_to_nav10.md
              - file_not_registered_to_nav11.md
              - file_not_registered_to_nav12.md
              - file_not_registered_to_nav13.md
              - file_not_registered_to_nav14.md
              - file_not_registered_to_nav15.md
              - file_not_registered_to_nav16.md
              - file_not_registered_to_nav17.md
              - file_not_registered_to_nav18.md
              - file_not_registered_to_nav19.md
              - file_not_registered_to_nav2.md
              - file_not_registered_to_nav20.md
              - file_not_registered_to_nav3.md
              - file_not_registered_to_nav4.md
              - file_not_registered_to_nav5.md
              - file_not_registered_to_nav6.md
              - file_not_registered_to_nav7.md
              - file_not_registered_to_nav8.md
              - file_not_registered_to_nav9.md
WARNING  -  Documentation file 'index.md' contains a link to 'broken_link.md' which is not found in the documentation files.
INFO     -  Documentation built in 0.06 seconds

As you can see, too many INFO logs are crowding out the WARNING logs, so you can't notice broken link.
(My private mkdocs project has 100 or more files that should not be registered to nav....)
On the other hand, mkdocs -q build prints nothing, so you can't notice the broken link.
But if user can select log level WARN, user can get the following log and immediately notice broken link!

$ mkdocs -l WARN build
WARNING  -  Documentation file 'index.md' contains a link to 'broken_link.md' which is not found in the documentation files.

My environment

  • Platform: WSL(Ubuntu 20.04 LTS) on Windows 11
  • MkDocs version: 1.3.0

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions