mkdocs-simple-plugin 3.2.4__tar.gz → 4.0.1__tar.gz

{mkdocs_simple_plugin-3.2.4 → mkdocs_simple_plugin-4.0.1}/.gitignore

@@ -9,3 +9,4 @@ dist/
 venv/
 docs/
 artifact.tar
+.env

{mkdocs_simple_plugin-3.2.4 → mkdocs_simple_plugin-4.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-simple-plugin
-Version: 3.2.4
+Version: 4.0.1
 Summary: Plugin for adding simple wiki site creation from markdown files interspersed within your code with MkDocs.
 Project-URL: Documentation, http://www.althack.dev/mkdocs-simple-plugin
 Project-URL: Homepage, http://www.althack.dev/mkdocs-simple-plugin
@@ -29,7 +29,7 @@ Description-Content-Type: text/markdown
 ![mkdocs-simple-plugin](https://github.com/athackst/mkdocs-simple-plugin/raw/main/media/mkdocs-simple-plugin.png)
 
 [![Test](https://github.com/athackst/mkdocs-simple-plugin/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/athackst/mkdocs-simple-plugin/actions/workflows/test.yml)
-[![Docs](https://github.com/athackst/mkdocs-simple-plugin/actions/workflows/publish_docs.yml/badge.svg?branch=main)](https://github.com/athackst/mkdocs-simple-plugin/actions/workflows/publish_docs.yml)
+[![Site](https://github.com/athackst/mkdocs-simple-plugin/actions/workflows/site.yml/badge.svg)](https://github.com/athackst/mkdocs-simple-plugin/actions/workflows/site.yml)
 [![Docker](https://img.shields.io/docker/pulls/althack/mkdocs-simple-plugin)](https://hub.docker.com/r/althack/mkdocs-simple-plugin)
 [![pypi](https://img.shields.io/pypi/dm/mkdocs-simple-plugin?label=pypi%20downloads&color=blue)](https://pypi.org/project/mkdocs-simple-plugin/)
 [![Github Action](https://img.shields.io/badge/github%20action-download-blue)](https://github.com/marketplace/actions/mkdocs-simple-action)

{mkdocs_simple_plugin-3.2.4 → mkdocs_simple_plugin-4.0.1}/README.md

@@ -1,7 +1,7 @@
 ![mkdocs-simple-plugin](https://github.com/athackst/mkdocs-simple-plugin/raw/main/media/mkdocs-simple-plugin.png)
 
 [![Test](https://github.com/athackst/mkdocs-simple-plugin/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/athackst/mkdocs-simple-plugin/actions/workflows/test.yml)
-[![Docs](https://github.com/athackst/mkdocs-simple-plugin/actions/workflows/publish_docs.yml/badge.svg?branch=main)](https://github.com/athackst/mkdocs-simple-plugin/actions/workflows/publish_docs.yml)
+[![Site](https://github.com/athackst/mkdocs-simple-plugin/actions/workflows/site.yml/badge.svg)](https://github.com/athackst/mkdocs-simple-plugin/actions/workflows/site.yml)
 [![Docker](https://img.shields.io/docker/pulls/althack/mkdocs-simple-plugin)](https://hub.docker.com/r/althack/mkdocs-simple-plugin)
 [![pypi](https://img.shields.io/pypi/dm/mkdocs-simple-plugin?label=pypi%20downloads&color=blue)](https://pypi.org/project/mkdocs-simple-plugin/)
 [![Github Action](https://img.shields.io/badge/github%20action-download-blue)](https://github.com/marketplace/actions/mkdocs-simple-action)

{mkdocs_simple_plugin-3.2.4 → mkdocs_simple_plugin-4.0.1}/mkdocs_simple_plugin/generator.py

@@ -53,24 +53,48 @@ def default_config():
     # Set the default edit uri to empty since doc files are built from source
     # and may not exist.
     config['edit_uri'] = ''
+    return config
+
+
+def apply_environment_config(config, existing_config=None):
+    """Set config values from non-empty environment inputs."""
+    existing_config = existing_config or {}
 
     def maybe_set_string(name):
+        env_variable = "DEFAULT_" + name.upper()
+        config_variable = name.lower()
+        config_exists = config_variable in existing_config
+        if os.environ.get(env_variable) and not config_exists:
+            config[config_variable] = os.environ[env_variable]
+
+    def maybe_set_dict(name, key):
+        env_variable = "DEFAULT_" + name.upper()
+        config_variable = name.lower()
+        config_exists = config_variable in existing_config
+        if os.environ.get(env_variable) and not config_exists:
+            config[config_variable] = {key: os.environ[env_variable]}
+
+    def set_string(name):
         env_variable = "INPUT_" + name.upper()
         config_variable = name.lower()
         if os.environ.get(env_variable):
             config[config_variable] = os.environ[env_variable]
 
-    def maybe_set_dict(name, key):
+    def set_dict(name, key):
         env_variable = "INPUT_" + name.upper()
         config_variable = name.lower()
         if os.environ.get(env_variable):
             config[config_variable] = {key: os.environ[env_variable]}
-    # Set the config variables via environment if exist
+
     maybe_set_string("site_name")
     maybe_set_string("site_url")
     maybe_set_string("repo_url")
     maybe_set_dict("theme", "name")
-    return config
+
+    set_string("site_name")
+    set_string("site_url")
+    set_string("repo_url")
+    set_dict("theme", "name")
 
 
 class MkdocsConfigDumper(yaml.Dumper):
@@ -100,9 +124,11 @@ def write_config(config_file, config):
 def setup_config(config_file="mkdocs.yml"):
     """Create the mkdocs.yml file with defaults for params that don't exist."""
     config = default_config()
+    local_config = {}
     if not os.path.exists(config_file):
         # If config file doesn't exit, create a simple one, guess the site name
         # from the folder name.
+        apply_environment_config(config)
         write_config(config_file, config)
     # Open the config file to verify settings.
     with open(config_file, 'r', encoding="utf-8") as stream:
@@ -112,6 +138,7 @@ def setup_config(config_file="mkdocs.yml"):
                 # Overwrite default config values with local mkdocs.yml
                 config.update(local_config)
                 print(config)
+            apply_environment_config(config, local_config)
             if not os.path.exists(config["docs_dir"]):
                 #  Ensure docs directory exists.
                 print("making docs_dir %s", config["docs_dir"])