stouputils 1.2.10__tar.gz → 1.2.11__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. {stouputils-1.2.10 → stouputils-1.2.11}/PKG-INFO +1 -1
  2. {stouputils-1.2.10 → stouputils-1.2.11}/pyproject.toml +1 -1
  3. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/applications/automatic_docs.py +8 -2
  4. {stouputils-1.2.10 → stouputils-1.2.11}/.gitignore +0 -0
  5. {stouputils-1.2.10 → stouputils-1.2.11}/LICENSE +0 -0
  6. {stouputils-1.2.10 → stouputils-1.2.11}/README.md +0 -0
  7. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/__init__.py +0 -0
  8. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/all_doctests.py +0 -0
  9. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/applications/__init__.py +0 -0
  10. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/archive.py +0 -0
  11. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/backup.py +0 -0
  12. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/collections.py +0 -0
  13. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/continuous_delivery/__init__.py +0 -0
  14. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/continuous_delivery/cd_utils.py +0 -0
  15. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/continuous_delivery/github.py +0 -0
  16. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/continuous_delivery/pypi.py +0 -0
  17. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/continuous_delivery/pyproject.py +0 -0
  18. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/ctx.py +0 -0
  19. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/decorators.py +0 -0
  20. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/dont_look/zip_file_override.py +0 -0
  21. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/io.py +0 -0
  22. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/parallel.py +0 -0
  23. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/print.py +0 -0
  24. {stouputils-1.2.10 → stouputils-1.2.11}/stouputils/py.typed +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: stouputils
3
- Version: 1.2.10
3
+ Version: 1.2.11
4
4
  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.
5
5
  Project-URL: Homepage, https://github.com/Stoupy51/stouputils
6
6
  Project-URL: Issues, https://github.com/Stoupy51/stouputils/issues
@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
5
5
 
6
6
  [project]
7
7
  name = "stouputils"
8
- version = "1.2.10"
8
+ version = "1.2.11"
9
9
  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."
10
10
  readme = "README.md"
11
11
  requires-python = ">=3.10"
@@ -80,6 +80,7 @@ from ..print import info
80
80
 
81
81
  def get_sphinx_conf_content(
82
82
  project: str,
83
+ project_dir: str,
83
84
  author: str,
84
85
  current_version: str,
85
86
  copyright: str,
@@ -94,6 +95,7 @@ def get_sphinx_conf_content(
94
95
 
95
96
  Args:
96
97
  project (str): Name of the project
98
+ project_dir (str): Path to the project directory
97
99
  author (str): Author of the project
98
100
  current_version (str): Current version
99
101
  copyright (str): Copyright information
@@ -107,12 +109,15 @@ def get_sphinx_conf_content(
107
109
  Returns:
108
110
  str: Content of the Sphinx configuration file
109
111
  """
112
+ parent_of_project_dir: str = clean_path(os.path.dirname(project_dir))
110
113
  conf_content: str = f"""
111
114
  # Imports
112
- import os
113
115
  import sys
114
116
  from typing import Any
115
117
 
118
+ # Add project_dir directory to Python path for module discovery
119
+ sys.path.insert(0, "{parent_of_project_dir}")
120
+
116
121
  # Project information
117
122
  project: str = "{project}"
118
123
  copyright: str = "{copyright}"
@@ -123,7 +128,7 @@ release: str = "{current_version}"
123
128
  extensions: list[str] = [
124
129
  "sphinx.ext.autodoc",
125
130
  "sphinx.ext.napoleon",
126
- "sphinx.ext.viewcode",
131
+ "sphinx.ext.viewcode",
127
132
  "sphinx.ext.githubpages",
128
133
  "sphinx.ext.intersphinx",
129
134
  "furo.sphinxext",
@@ -468,6 +473,7 @@ def update_documentation(
468
473
  conf_path: str = f"{source_dir}/conf.py"
469
474
  conf_content: str = get_conf_content_function(
470
475
  project=project,
476
+ project_dir=project_dir,
471
477
  author=author,
472
478
  current_version=current_version,
473
479
  copyright=copyright,
File without changes
File without changes
File without changes