starred/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2026-03-31 06:33:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

Automatically disable MkDocs 2.0 warning for forks of MkDocs

Browse Source
This commit is contained in:
squidfunk
2026-03-19 16:37:10 +01:00
parent 6f9a48b404
commit 51d9b76636
4 changed files with 80 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
material/plugins/__init__.py
View File

@@ -17,29 +17,3 @@
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
from colorama import Fore, Style
from os import getenv
from sys import stderr
# Silence this warning with NO_MKDOCS_2_WARNING=1
if not getenv("NO_MKDOCS_2_WARNING"):
print(
"\n"
f"{Fore.RED} │ ⚠ Warning from the Material for MkDocs team{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL} MkDocs 2.0, the underlying framework of Material for MkDocs,\n"
f"{Fore.RED} │{Style.RESET_ALL} will introduce backward-incompatible changes, including:\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │ × {Style.RESET_ALL}All plugins will stop working – the plugin system has been removed\n"
f"{Fore.RED} │ × {Style.RESET_ALL}All theme overrides will break – the theming system has been rewritten\n"
f"{Fore.RED} │ × {Style.RESET_ALL}No migration path exists – existing projects cannot be upgraded\n"
f"{Fore.RED} │ × {Style.RESET_ALL}Closed contribution model – community members can't report bugs\n"
f"{Fore.RED} │ × {Style.RESET_ALL}Currently unlicensed – unsuitable for production use\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL} Our full analysis:\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL} \033[4mhttps://squidfunk.github.io/mkdocs-material/blog/2026/02/18/mkdocs-2.0/{Style.RESET_ALL}\n"
f"{Style.RESET_ALL}",
file=stderr
)

40
material/templates/__init__.py
View File

@@ -17,3 +17,43 @@
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
import os
import sys
from colorama import Fore, Style
from pathlib import Path
from sys import stderr
# Check if we're running MkDocs. Disable the warning automatically for other
# contexts, e.g., to allow for forks of MkDocs to adjust behavior to fit
def is_mkdocs():
path = Path(sys.argv[0])
return path.name in ("mkdocs", "mkdocs.exe") or (
path.name == "__main__.py" and path.parent.name == "mkdocs"
)
# Check if we're running MkDocs and the warning hasn't been disabled
if is_mkdocs() and not os.getenv("NO_MKDOCS_2_WARNING"):
print(
"\n"
f"{Fore.RED} │ ⚠ Warning from the Material for MkDocs team{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL} MkDocs 2.0, the underlying framework of Material for MkDocs,\n"
f"{Fore.RED} │{Style.RESET_ALL} will introduce backward-incompatible changes, including:\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │ × {Style.RESET_ALL}All plugins will stop working – the plugin system has been removed\n"
f"{Fore.RED} │ × {Style.RESET_ALL}All theme overrides will break – the theming system has been rewritten\n"
f"{Fore.RED} │ × {Style.RESET_ALL}No migration path exists – existing projects cannot be upgraded\n"
f"{Fore.RED} │ × {Style.RESET_ALL}Closed contribution model – community members can't report bugs\n"
f"{Fore.RED} │ × {Style.RESET_ALL}Currently unlicensed – unsuitable for production use\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL} Our full analysis:\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL} \033[4mhttps://squidfunk.github.io/mkdocs-material/blog/2026/02/18/mkdocs-2.0/{Style.RESET_ALL}\n"
f"{Style.RESET_ALL}",
file=stderr
)
# Disable for subsequent imports
os.environ["NO_MKDOCS_2_WARNING"] = "true"

26
src/plugins/__init__.py
View File

@@ -17,29 +17,3 @@
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
from colorama import Fore, Style
from os import getenv
from sys import stderr
# Silence this warning with NO_MKDOCS_2_WARNING=1
if not getenv("NO_MKDOCS_2_WARNING"):
print(
"\n"
f"{Fore.RED} │ ⚠ Warning from the Material for MkDocs team{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL} MkDocs 2.0, the underlying framework of Material for MkDocs,\n"
f"{Fore.RED} │{Style.RESET_ALL} will introduce backward-incompatible changes, including:\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │ × {Style.RESET_ALL}All plugins will stop working – the plugin system has been removed\n"
f"{Fore.RED} │ × {Style.RESET_ALL}All theme overrides will break – the theming system has been rewritten\n"
f"{Fore.RED} │ × {Style.RESET_ALL}No migration path exists – existing projects cannot be upgraded\n"
f"{Fore.RED} │ × {Style.RESET_ALL}Closed contribution model – community members can't report bugs\n"
f"{Fore.RED} │ × {Style.RESET_ALL}Currently unlicensed – unsuitable for production use\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL} Our full analysis:\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL} \033[4mhttps://squidfunk.github.io/mkdocs-material/blog/2026/02/18/mkdocs-2.0/{Style.RESET_ALL}\n"
f"{Style.RESET_ALL}",
file=stderr
)

40
src/templates/__init__.py
View File

@@ -17,3 +17,43 @@
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
import os
import sys
from colorama import Fore, Style
from pathlib import Path
from sys import stderr
# Check if we're running MkDocs. Disable the warning automatically for other
# contexts, e.g., to allow for forks of MkDocs to adjust behavior to fit
def is_mkdocs():
path = Path(sys.argv[0])
return path.name in ("mkdocs", "mkdocs.exe") or (
path.name == "__main__.py" and path.parent.name == "mkdocs"
)
# Check if we're running MkDocs and the warning hasn't been disabled
if is_mkdocs() and not os.getenv("NO_MKDOCS_2_WARNING"):
print(
"\n"
f"{Fore.RED} │ ⚠ Warning from the Material for MkDocs team{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL} MkDocs 2.0, the underlying framework of Material for MkDocs,\n"
f"{Fore.RED} │{Style.RESET_ALL} will introduce backward-incompatible changes, including:\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │ × {Style.RESET_ALL}All plugins will stop working – the plugin system has been removed\n"
f"{Fore.RED} │ × {Style.RESET_ALL}All theme overrides will break – the theming system has been rewritten\n"
f"{Fore.RED} │ × {Style.RESET_ALL}No migration path exists – existing projects cannot be upgraded\n"
f"{Fore.RED} │ × {Style.RESET_ALL}Closed contribution model – community members can't report bugs\n"
f"{Fore.RED} │ × {Style.RESET_ALL}Currently unlicensed – unsuitable for production use\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL} Our full analysis:\n"
f"{Fore.RED} │{Style.RESET_ALL}\n"
f"{Fore.RED} │{Style.RESET_ALL} \033[4mhttps://squidfunk.github.io/mkdocs-material/blog/2026/02/18/mkdocs-2.0/{Style.RESET_ALL}\n"
f"{Style.RESET_ALL}",
file=stderr
)
# Disable for subsequent imports
os.environ["NO_MKDOCS_2_WARNING"] = "true"