Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Disable Rendering source page info messages #248

Closed
mhussein opened this issue Oct 11, 2024 · 10 comments
Closed

Disable Rendering source page info messages #248

mhussein opened this issue Oct 11, 2024 · 10 comments
Labels
Annoyance Something annoying (not a bug) fixed A fix has been submitted

Comments

@mhussein
Copy link

We recently updated from 1.0.5 to 1.3.5 and started seeing a lot of messages in the log, for example

INFO    -  [macros] - Rendering source page: index.md
INFO    -  [macros] - Rendering source page: apis.md
INFO    -  [macros] - Rendering source page: docs.md
INFO    -  [macros] - Rendering source page: tags.md
...
...

Is there a way to suppress those log messages?

Copy link

Welcome to this project and thank you!

@fralau
Copy link
Owner

fralau commented Oct 11, 2024

Good question. We could perhaps downgrade some of these messages as DEBUG? 🤔

Aside of these, which are the ones you find annoying?

@fralau fralau added the Annoyance Something annoying (not a bug) label Oct 11, 2024
@mhussein
Copy link
Author

my 2c

The "Macros arguments" one feels like Debug, but it is useful, so maybe keep it as INFO, similar to the "Loading yaml file" ones.

The "Configuring the macros environment..." and "End of environment config" are useless outside debug env. Those can go.

The "config [variables|macros|filters] again feels like debug, but they are useful to discover things you can do that you may not be aware of.

@fralau
Copy link
Owner

fralau commented Oct 11, 2024

Thanks for the feedback. I'll have a look at this.

For the context, I introduced a new testing framework (see #244), so I went a little overboard. 🙂

In reality, the testing framework relies minimally on the log, except for reading the variables, filters and macros (but these are DEBUG entries, not INFO).

@michsien104
Copy link

This is indeed really annoying. Waiting for that fix as well.

@fralau
Copy link
Owner

fralau commented Oct 14, 2024

@michsien104 It's good to know. 🙂

@mark-bozeman
Copy link

A fix would be great.

fralau pushed a commit that referenced this issue Oct 16, 2024
@fralau fralau added fixed A fix has been submitted please test An updated was pushed. This needs to be tested labels Oct 16, 2024
@fralau
Copy link
Owner

fralau commented Oct 16, 2024

@mhussein , @michsien104, @mark-bozeman Fixed.

Could I ask you to test whether it's fine for you now?

fralau pushed a commit that referenced this issue Oct 16, 2024
@mhussein
Copy link
Author

@fralau Thanks a lot.

  1. I installed 1.3.5, ran mkdocs serve, verified that I get a ton of messages from the macros plugin.
  2. Installed 1.3.6, ran mkdocs serve again, and verified that the extra messages are no longer there.

I still get those log messages, which I think is perfectly fine:

INFO    -  [macros] - Loading yaml file: C:\macros/dictionary.yaml
INFO    -  [macros] - No default module `main` found
INFO    -  [macros] - Config variables: ['extra', 'config', 'environment', 'plugin', 'git', 'hide', 'macros', 'filters', 'filters_builtin']
INFO    -  [macros] - Config macros: ['context', 'macros_info', 'now', 'fix_url']
INFO    -  [macros] - Config filters: ['pretty', 'relative_url']

@fralau
Copy link
Owner

fralau commented Oct 17, 2024

@mhussein Thanks a lot!

@fralau fralau closed this as completed Oct 19, 2024
@fralau fralau removed the please test An updated was pushed. This needs to be tested label Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Annoyance Something annoying (not a bug) fixed A fix has been submitted
Projects
None yet
Development

No branches or pull requests

4 participants