stouputils 1.2.9__tar.gz → 1.2.11__tar.gz

{stouputils-1.2.9 → stouputils-1.2.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.2.9
+Version: 1.2.11
 Summary: Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more.
 Project-URL: Homepage, https://github.com/Stoupy51/stouputils
 Project-URL: Issues, https://github.com/Stoupy51/stouputils/issues

{stouputils-1.2.9 → stouputils-1.2.11}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.2.9"
+version = "1.2.11"
 description = "Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more."
 readme = "README.md"
 requires-python = ">=3.10"

{stouputils-1.2.9 → stouputils-1.2.11}/stouputils/applications/automatic_docs.py

@@ -80,6 +80,7 @@ from ..print import info
 
 def get_sphinx_conf_content(
 	project: str,
+	project_dir: str,
 	author: str,
 	current_version: str,
 	copyright: str,
@@ -94,6 +95,7 @@ def get_sphinx_conf_content(
 
 	Args:
 		project           (str):              Name of the project
+		project_dir       (str):              Path to the project directory
 		author            (str):              Author of the project
 		current_version   (str):              Current version
 		copyright         (str):              Copyright information
@@ -107,12 +109,15 @@ def get_sphinx_conf_content(
 	Returns:
 		str: Content of the Sphinx configuration file
 	"""
+	parent_of_project_dir: str = clean_path(os.path.dirname(project_dir))
 	conf_content: str = f"""
 # Imports
-import os
 import sys
 from typing import Any
 
+# Add project_dir directory to Python path for module discovery
+sys.path.insert(0, "{parent_of_project_dir}")
+
 # Project information
 project: str = "{project}"
 copyright: str = "{copyright}"
@@ -123,7 +128,7 @@ release: str = "{current_version}"
 extensions: list[str] = [
 	"sphinx.ext.autodoc",
 	"sphinx.ext.napoleon",
-	"sphinx.ext.viewcode", 
+	"sphinx.ext.viewcode",
 	"sphinx.ext.githubpages",
 	"sphinx.ext.intersphinx",
 	"furo.sphinxext",
@@ -386,6 +391,7 @@ def generate_redirect_html(filepath: str) -> None:
 def update_documentation(
 	root_path: str,
 	project: str,
+	project_dir: str = "",
 	author: str = "Author",
 	copyright: str = "2025, Author",
 	html_logo: str = "",
@@ -406,6 +412,7 @@ def update_documentation(
 	Args:
 		root_path                  (str): Root path of the project
 		project                    (str): Name of the project
+		project_dir                (str): Path to the project directory (to be used with generate_docs_function)
 		author                     (str): Author of the project
 		copyright                  (str): Copyright information
 		html_logo                  (str): URL to the logo
@@ -466,6 +473,7 @@ def update_documentation(
 	conf_path: str = f"{source_dir}/conf.py"
 	conf_content: str = get_conf_content_function(
 		project=project,
+		project_dir=project_dir,
 		author=author,
 		current_version=current_version,
 		copyright=copyright,
@@ -483,7 +491,7 @@ def update_documentation(
 	generate_docs_function(
 		source_dir=source_dir,
 		modules_dir=modules_dir,
-		project_dir=f"{root_path}/{project}",
+		project_dir=project_dir if project_dir else f"{root_path}/{project}",
 		build_dir=build_dir,
 	)