stouputils 1.2.10__tar.gz → 1.2.12__tar.gz

{stouputils-1.2.10 → stouputils-1.2.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.2.10
+Version: 1.2.12
 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.10 → stouputils-1.2.12}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.2.10"
+version = "1.2.12"
 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.10 → stouputils-1.2.12}/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",
@@ -300,11 +305,12 @@ def generate_index_rst(
 	version_selector += ", ".join(version_links)
 		
 	# Generate module documentation section
+	project_module: str = project.lower()
 	module_docs: str = f"""
 .. toctree::
    :maxdepth: 10
 
-   modules/{project}
+   modules/{project_module}
 """
 
 	# Convert markdown to RST
@@ -468,6 +474,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,