Merge pull request #150 from Guts/improve/handle-missing-site-url

Improve: handle missing site url

Author: Guts

mkdocs_rss_plugin/plugin.py

@@ -172,7 +172,7 @@ def on_config(self, config: config_options.Config) -> dict:
                 base_feed.get("html_url") + OUTPUT_FEED_UPDATED
             )
         else:
-            logging.warning(
+            logger.error(
                 "[rss-plugin] The variable `site_url` is not set in the MkDocs "
                 "configuration file whereas a URL is mandatory to publish. "
                 "See: https://validator.w3.org/feed/docs/rss2.html#requiredChannelElements"

mkdocs_rss_plugin/util.py

@@ -87,6 +87,13 @@ def build_url(self, base_url: str, path: str, args_dict: dict = None) -> str:
         :return: complete and valid URL
         :rtype: str
         """
+        if not base_url:
+            logger.error(
+                "[rss-plugin] Base url not set, probably because 'site_url' is not set "
+                "in Mkdocs configuration file. Using an empty string instead."
+            )
+            base_url = ""
+
         # Returns a list in the structure of urlparse.ParseResult
         url_parts = list(urlparse(base_url))
         url_parts[2] += path

tests/fixtures/mkdocs_pretty_print_disabled.yml

@@ -1,6 +1,6 @@
 site_name: Test RSS Plugin
 site_description: Test RSS Plugin
-
+site_url: https://guts.github.io/mkdocs-rss-plugin
 use_directory_urls: true
 
 plugins:

tests/fixtures/mkdocs_pretty_print_enabled.yml

@@ -1,5 +1,6 @@
 site_name: Test RSS Plugin
 site_description: Test RSS Plugin
+site_url: https://guts.github.io/mkdocs-rss-plugin
 
 use_directory_urls: true