Bump actions/upload-artifact from 4 to 5 in /.github/workflows (#166)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Glenn Jocher <[email protected]>
Co-authored-by: UltralyticsAssistant <[email protected]>

Author: 3 people

.github/workflows/publish.yml

@@ -70,7 +70,7 @@ jobs:
       - uses: astral-sh/setup-uv@v7
       - run: uv pip install --system --no-cache build
       - run: python -m build
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v5
         with:
           name: dist
           path: dist/

plugin/main.py

@@ -26,16 +26,15 @@
 
 
 class MetaPlugin(BasePlugin):
-    """
-    MetaPlugin class for enhancing MkDocs documentation with metadata, social sharing, and structured data.
+    """MetaPlugin class for enhancing MkDocs documentation with metadata, social sharing, and structured data.
 
-    This class extends the BasePlugin class from MkDocs to add various meta tags, social sharing buttons, and
-    structured data to the generated HTML pages. It also retrieves git information for each file to include
-    authorship and modification details.
+    This class extends the BasePlugin class from MkDocs to add various meta tags, social sharing buttons, and structured
+    data to the generated HTML pages. It also retrieves git information for each file to include authorship and
+    modification details.
 
     Attributes:
-        config_scheme (tuple): Configuration options for the plugin including verbose output, default images,
-            authors, and various feature toggles for descriptions, images, keywords, share buttons, and JSON-LD.
+        config_scheme (tuple): Configuration options for the plugin including verbose output, default images, authors,
+            and various feature toggles for descriptions, images, keywords, share buttons, and JSON-LD.
 
     Methods:
         get_git_info: Retrieve git information of a specified file including hash, date, and branch.
@@ -99,8 +98,7 @@ def get_git_info(self, file_path: str) -> dict[str, Any]:
         return git_info
 
     def on_page_content(self, content: str, page, config, files) -> str:
-        """
-        Process page content with optional enhancements like images, descriptions, and keywords.
+        """Process page content with optional enhancements like images, descriptions, and keywords.
 
         Args:
             content (str): The content of the page in HTML format.
@@ -146,18 +144,12 @@ def on_page_content(self, content: str, page, config, files) -> str:
 
     @staticmethod
     def insert_content(soup: BeautifulSoup, content_to_insert) -> None:
-        """
-        Insert additional content into a BeautifulSoup object at a specified location.
+        """Insert additional content into a BeautifulSoup object at a specified location.
 
         Args:
             soup (BeautifulSoup): The BeautifulSoup object representing the HTML content.
             content_to_insert (Tag | NavigableString): The HTML content to be inserted.
 
-        Notes:
-            This function specifically searches for an HTML element with the id "__comments" and inserts the
-            content_to_insert before it. If the "__comments" element is not found, it defaults to appending
-            the content to the element with class "md-content__inner".
-
         Examples:
             Insert content into a BeautifulSoup object
             >>> from bs4 import BeautifulSoup
@@ -166,6 +158,11 @@ def insert_content(soup: BeautifulSoup, content_to_insert) -> None:
             >>> new_content = soup.new_tag('div', id='new')
             >>> new_content.string = "This is new content"
             >>> MetaPlugin.insert_content(soup, new_content)
+
+        Notes:
+            This function specifically searches for an HTML element with the id "__comments" and inserts the
+            content_to_insert before it. If the "__comments" element is not found, it defaults to appending
+            the content to the element with class "md-content__inner".
         """
         if comments_header := soup.find("h2", id="__comments"):
             comments_header.insert_before(content_to_insert)
@@ -175,27 +172,26 @@ def insert_content(soup: BeautifulSoup, content_to_insert) -> None:
 
     @staticmethod
     def parse_faq(soup: BeautifulSoup) -> list[dict[str, Any]]:
-        """
-        Parse the FAQ questions and answers from the HTML page content.
+        """Parse the FAQ questions and answers from the HTML page content.
 
         Args:
             soup (BeautifulSoup): The BeautifulSoup object representing the HTML page content.
 
         Returns:
-            faqs (List[Dict[str, Any]]): A list of dictionaries, each containing a parsed FAQ entry with 'Question'
-                and 'Answer' fields following the JSON-LD schema.
-
-        Notes:
-            This method identifies the FAQ section by looking for an `h2` tag with the text "FAQ". Each question is
-            identified by an `h3` tag, and its corresponding answer is captured from `p` tags until the next `h3` or
-            `h2` tag.
+            faqs (List[Dict[str, Any]]): A list of dictionaries, each containing a parsed FAQ entry with 'Question' and
+                'Answer' fields following the JSON-LD schema.
 
         Examples:
             Parse FAQ content from HTML
             >>> from bs4 import BeautifulSoup
             >>> html_content = '<h2>FAQ</h2><h3>Question 1?</h3><p>Answer to question 1.</p>'
             >>> soup = BeautifulSoup(html_content, 'html.parser')
             >>> faq_data = MetaPlugin.parse_faq(soup)
+
+        Notes:
+            This method identifies the FAQ section by looking for an `h2` tag with the text "FAQ". Each question is
+            identified by an `h3` tag, and its corresponding answer is captured from `p` tags until the next `h3` or
+            `h2` tag.
         """
         faqs = []
         if faq_section := soup.find("h2", string="FAQ"):
@@ -226,8 +222,7 @@ def parse_faq(soup: BeautifulSoup) -> list[dict[str, Any]]:
         return faqs
 
     def on_post_page(self, output: str, page, config) -> str:
-        """
-        Enhance the HTML output of a page with metadata tags, git information, and share buttons.
+        """Enhance the HTML output of a page with metadata tags, git information, and share buttons.
 
         Args:
             output (str): The HTML content of the rendered page.

plugin/utils.py

@@ -18,8 +18,7 @@
 
 
 def calculate_time_difference(date_string: str) -> tuple[str, str]:
-    """
-    Calculate the time difference between a given date and the current date in a human-readable format.
+    """Calculate the time difference between a given date and the current date in a human-readable format.
 
     Args:
         date_string (str): Date and time string in the format "%Y-%m-%d %H:%M:%S %z".
@@ -50,12 +49,11 @@ def calculate_time_difference(date_string: str) -> tuple[str, str]:
 
 
 def get_youtube_video_ids(soup: BeautifulSoup) -> list[str]:
-    """
-    Extract YouTube video IDs from iframe elements present in the provided BeautifulSoup object.
+    """Extract YouTube video IDs from iframe elements present in the provided BeautifulSoup object.
 
     Args:
-        soup (BeautifulSoup): A BeautifulSoup object containing the HTML content from which YouTube video IDs need
-            to be extracted.
+        soup (BeautifulSoup): A BeautifulSoup object containing the HTML content from which YouTube video IDs need to be
+            extracted.
 
     Returns:
         (List[str]): A list containing YouTube video IDs extracted from the HTML content.
@@ -86,8 +84,7 @@ def get_youtube_video_ids(soup: BeautifulSoup) -> list[str]:
 def get_github_username_from_email(
     email: str, cache: dict, file_path: str = "", verbose: bool = True
 ) -> tuple[str | None, str | None]:
-    """
-    Retrieve the GitHub username and avatar URL associated with the given email address.
+    """Retrieve the GitHub username and avatar URL associated with the given email address.
 
     Args:
         email (str): The email address to retrieve the GitHub username for.
@@ -139,8 +136,7 @@ def get_github_username_from_email(
 
 
 def get_github_usernames_from_file(file_path: str, default_user: str | None = None) -> dict[str, dict[str, any]]:
-    """
-    Fetch GitHub usernames associated with a file using Git Log and Git Blame commands.
+    """Fetch GitHub usernames associated with a file using Git Log and Git Blame commands.
 
     Args:
         file_path (str): The path to the file for which GitHub usernames are to be retrieved.