Skip to content

Change the environment variable that is used to suppress the nag message #53

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.

Sign up for GitHub

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

Merged
oprypin merged 2 commits into from
Mar 20, 2026
+4 −6
Merged

Change the environment variable that is used to suppress the nag message #53

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8e0a9a
Change the environment variable that is used to suppress the nag message
oprypin Mar 19, 2026
545eca2
Add a direct mention how to suppress the warning
oprypin Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions properdocs/replacement_warning.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
To avoid these risks, switch to *ProperDocs*, a continuation of MkDocs 1.x and a drop-in replacement that supports your current MkDocs setup.
Simply install it with `pip install properdocs` and build your site with `properdocs build` instead of the MkDocs equivalents.

Alternatively, to just skip this warning in the future, you can set the environment variable `DISABLE_MKDOCS_2_WARNING=true`.

For more info visit https://github.com/ProperDocs/properdocs/discussions/33 and https://properdocs.org/

(This warning was initiated by one of the plugins that you depend on.)
Expand All @@ -44,14 +46,10 @@ def setup():
return

if is_running_from_mkdocs():
# Allow to silence this warning with NO_MKDOCS_2_WARNING=true
if os.environ.get('NO_MKDOCS_2_WARNING', '').lower() != 'true':
# Allow to silence this warning with DISABLE_MKDOCS_2_WARNING=true
if os.environ.get('DISABLE_MKDOCS_2_WARNING', '').lower() != 'true':
print(colorize_message(_warning_message), file=sys.stderr) # noqa: T201

# Prevent warnings from the theme that already uses this environment variable.
# That warning does not apply to ProperDocs.
os.environ['NO_MKDOCS_2_WARNING'] = 'true'

_warning_message = '' # Disable all activations other than the first one.


Expand Down
Loading