Fixes Page class references in documentation (#3117)

mkdocs.nav.Pages => mkdocs.structure.pages.Page
mkdocs · Apr 21, 2023 · c32ce4d · c32ce4d
1 parent 49fbc35
commit c32ce4d
Showing 1 changed file with 7 additions and 7 deletions.
diff --git a/mkdocs/plugins.py b/mkdocs/plugins.py
@@ -325,12 +325,12 @@ def on_pre_page(self, page: Page, *, config: MkDocsConfig, files: Files) -> Opti
         page and can be used to alter the `Page` instance.
 
         Parameters:
-            page: `mkdocs.nav.Page` instance
+            page: `mkdocs.structure.pages.Page` instance
             config: global configuration object
             files: global files collection
 
         Returns:
-            `mkdocs.nav.Page` instance
+            `mkdocs.structure.pages.Page` instance
         """
         return page
 
@@ -340,7 +340,7 @@ def on_page_read_source(self, *, page: Page, config: MkDocsConfig) -> Optional[s
         the contents of a page's source from the filesystem.
 
         Parameters:
-            page: `mkdocs.nav.Page` instance
+            page: `mkdocs.structure.pages.Page` instance
             config: global configuration object
 
         Returns:
@@ -359,7 +359,7 @@ def on_page_markdown(
 
         Parameters:
             markdown: Markdown source text of page as string
-            page: `mkdocs.nav.Page` instance
+            page: `mkdocs.structure.pages.Page` instance
             config: global configuration object
             files: global files collection
 
@@ -378,7 +378,7 @@ def on_page_content(
 
         Parameters:
             html: HTML rendered from Markdown source as string
-            page: `mkdocs.nav.Page` instance
+            page: `mkdocs.structure.pages.Page` instance
             config: global configuration object
             files: global files collection
 
@@ -396,7 +396,7 @@ def on_page_context(
 
         Parameters:
             context: dict of template context variables
-            page: `mkdocs.nav.Page` instance
+            page: `mkdocs.structure.pages.Page` instance
             config: global configuration object
             nav: global navigation object
 
@@ -414,7 +414,7 @@ def on_post_page(self, output: str, *, page: Page, config: MkDocsConfig) -> Opti
 
         Parameters:
             output: output of rendered template as string
-            page: `mkdocs.nav.Page` instance
+            page: `mkdocs.structure.pages.Page` instance
             config: global configuration object
 
         Returns: