autodocgenerator 0.8.9.7__py3-none-any.whl → 0.8.9.8__py3-none-any.whl

autodocgenerator/auto_runner/config_reader.py

@@ -1,5 +1,5 @@
 import yaml
-from autodocgenerator.factory.modules.general_modules import CustomModule
+from autodocgenerator.factory.modules.general_modules import CustomModule, CustomModuleWithOutContext
 from ..config.config import Config, ProjectConfigSettings
 
 
@@ -29,6 +29,6 @@ def read_config(file_data: str) -> tuple[Config, list[CustomModule]]:
 
     custom_discriptions = data.get("custom_descriptions", [])
 
-    custom_modules = [CustomModule(custom_discription) for custom_discription in custom_discriptions]
+    custom_modules = [CustomModuleWithOutContext(custom_discription[1:])  if custom_discription[0] == "%" else CustomModule(custom_discription) for custom_discription in custom_discriptions]
 
     return config, custom_modules

autodocgenerator/auto_runner/run_file.py

@@ -21,11 +21,11 @@ def gen_doc(project_path: str, config: Config, custom_modules):
     )
 
 
-    manager.generate_code_file()
-    manager.generete_doc_parts(max_symbols=5000)
+    # manager.generate_code_file()
+    # manager.generete_doc_parts(max_symbols=5000)
     manager.factory_generate_doc(DocFactory(*custom_modules))
-    manager.order_doc()
-    manager.factory_generate_doc(DocFactory(IntroLinks()))
+    # manager.order_doc()
+    # manager.factory_generate_doc(DocFactory(IntroLinks()))
     manager.clear_cache()
 
     return manager.read_file_by_file_key("output_doc")

autodocgenerator/factory/modules/general_modules.py

@@ -1,6 +1,6 @@
 from ..base_factory import BaseModule
 from ...engine.models.model import Model
-from ...postprocessor.custom_intro import generete_custom_discription
+from ...postprocessor.custom_intro import generete_custom_discription, generete_custom_discription_without
 from ...preprocessor.spliter import split_data
 
 class CustomModule(BaseModule):
@@ -10,5 +10,15 @@ class CustomModule(BaseModule):
         self.discription = discription  
 
     def generate(self, info: dict, model: Model):
-        result = generete_custom_discription(split_data(info.get("code_mix"), max_symbols=7000), model, self.discription, info.get("language"))
+        result = generete_custom_discription(split_data(info.get("code_mix"), max_symbols=5000), model, self.discription, info.get("language"))
+        return result
+    
+class CustomModuleWithOutContext(BaseModule):
+
+    def __init__(self, discription: str):
+        super().__init__()
+        self.discription = discription  
+
+    def generate(self, info: dict, model: Model):
+        result = generete_custom_discription_without(model, self.discription, info.get("language"))
         return result

autodocgenerator/postprocessor/custom_intro.py

@@ -99,4 +99,34 @@ def generete_custom_discription(splited_data: str, model: Model, custom_descript
         if (result.find("!noinfo") == -1 and result.find("No information found") == -1) or result.find("!noinfo") > 30:
             break
         result = ""
-    return result
+    return result
+
+def generete_custom_discription_without(model: Model, custom_description: str, language: str = "en") -> str:
+    prompt = [
+         {
+            "role": "system",
+            "content": f"For the following task use language {language}"
+        },
+        {
+            "role": "system",
+            "content": f"Act as a precise Technical Analyst. You will be provided with specific code or documentation. Your task is to describe and rewrite the following text"
+        },
+        {
+            "role": "system",
+            "content": """Every response must start with exactly one <a name="CONTENT_DESCRIPTION"></a> tag. The CONTENT_DESCRIPTION must be a short, hyphenated summary of the actual information you are providing (e.g., "user-authentication-logic" instead of "auth.yml"). STRICT RULES:
+
+NO filenames or paths (e.g., forbidden: "autodocconfig.yml", "src/config").
+NO file extensions (e.g., forbidden: ".yml", ".md").
+NO generic terms (e.g., forbidden: "config", "settings", "run", "docs").
+NO protocols (http/https).
+This tag must appear ONLY ONCE at the very beginning. Never repeat it or use other links"""
+        },
+        {
+            "role": "user",
+            "content": f"### Task to discribe: {custom_description}"
+        }
+    ]
+
+    result = model.get_answer_without_history(prompt=prompt)
+    return result
+

{autodocgenerator-0.8.9.7.dist-info → autodocgenerator-0.8.9.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: autodocgenerator
-Version: 0.8.9.7
+Version: 0.8.9.8
 Summary: This Project helps you to create docs for your projects
 License: MIT
 Author: dima-on

{autodocgenerator-0.8.9.7.dist-info → autodocgenerator-0.8.9.8.dist-info}/RECORD

@@ -1,6 +1,6 @@
 autodocgenerator/__init__.py,sha256=umUGEkIa6y8lThs0iXDSpYQ5x-EhPpNJMeKotAaN_hI,161
-autodocgenerator/auto_runner/config_reader.py,sha256=tma7PdzdRxrlaDXs8ucBWawS0QE44oSjZxCtstzMbyU,1099
-autodocgenerator/auto_runner/run_file.py,sha256=WouFAUXCH5lCD5IQA88BwYMeTzbBsl7kX97aXxj5Ufk,1389
+autodocgenerator/auto_runner/config_reader.py,sha256=2BcbblII3EIdi6JZFz3N1eHqxX23_R34_xBwJgr5PGM,1216
+autodocgenerator/auto_runner/run_file.py,sha256=I4catkMUm0gRAlGYL4qVxW5mBxMGBgTkWAmb0yu8IMQ,1397
 autodocgenerator/config/config.py,sha256=M6q999CHKh91hKwxjgBKA6q816XO5BEGj53m1t17On8,1782
 autodocgenerator/engine/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 autodocgenerator/engine/config/config.py,sha256=Ov2SJlJR_9n7aOZk_6jZzHAsyMNFisseAUUJgi6RGSQ,8009
@@ -9,10 +9,10 @@ autodocgenerator/engine/models/gpt_model.py,sha256=SSXj1o1GV2Y3hQZ7B7WOWTjuLE_iS
 autodocgenerator/engine/models/model.py,sha256=LaN3andzG3czmy0jFU60P9ji33BAi1rmqWM2titVZ8w,1901
 autodocgenerator/factory/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 autodocgenerator/factory/base_factory.py,sha256=NsAWFoTO14XjJ2w9WseoBUb75ooYHEVVEnsW8iIDqSo,1155
-autodocgenerator/factory/modules/general_modules.py,sha256=7Ukebf-7JOgOQeeIkRfmcCFwxBoJgZN-mUEE6ZYo3jc,556
+autodocgenerator/factory/modules/general_modules.py,sha256=dLkQmGB5K1gGDTmYzBAC_WLxEhdC9KGRDc8i-DwKM_g,928
 autodocgenerator/factory/modules/intro.py,sha256=0pPz9pL0WpD098J7CFvLC6g144LWQAHVLNHuxETY25c,606
 autodocgenerator/manage.py,sha256=y9XFyfTUZQgMmm91vfG2RQiPGIdFcyp3UcFz68qhhks,4930
-autodocgenerator/postprocessor/custom_intro.py,sha256=Poq1JBaDbrH5HOQZlVDoR9JOlmDIdcP-Jn_q5hUqKoI,3206
+autodocgenerator/postprocessor/custom_intro.py,sha256=FH4IfCmmyWzNVVpaK3iO1VIAqtAi2eeyeRiKBcUChmM,4547
 autodocgenerator/postprocessor/sorting.py,sha256=KAPSdwUtxmYBMSajI7V7DVzpiFKpBspHLYMXTOXeZxM,2320
 autodocgenerator/preprocessor/code_mix.py,sha256=KdBXqHtYkoi-g2f6Kq0IsT9jtkGvt2LWm7w9d-2I1AY,2502
 autodocgenerator/preprocessor/compressor.py,sha256=VQejX55aD5gwC_ov7JV0vW9DNhFP0G3_zYEp38pV4FY,5173
@@ -21,6 +21,6 @@ autodocgenerator/preprocessor/spliter.py,sha256=kjU4WRBepLI0JrW7BXSmHb3VxzjzBwVc
 autodocgenerator/ui/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 autodocgenerator/ui/logging.py,sha256=r0dWxYvShJjbJVM5P4NYmEvZybrwSGx8Th2ybLOCZuE,1684
 autodocgenerator/ui/progress_base.py,sha256=LCa-Df_JWvqWRgzglZyu-rM4X2q8pJ1OlXTAbc2v3Ls,1947
-autodocgenerator-0.8.9.7.dist-info/METADATA,sha256=FvFiyz2lJcps1MmUdWE2aKpEXAhO4YNs1RPqYmGeVbY,42485
-autodocgenerator-0.8.9.7.dist-info/WHEEL,sha256=3ny-bZhpXrU6vSQ1UPG34FoxZBp3lVcvK0LkgUz6VLk,88
-autodocgenerator-0.8.9.7.dist-info/RECORD,,
+autodocgenerator-0.8.9.8.dist-info/METADATA,sha256=vUBl3409SF4VpOk2Pq6J8GiO2e7loDJshUxpZ_cg7so,42485
+autodocgenerator-0.8.9.8.dist-info/WHEEL,sha256=3ny-bZhpXrU6vSQ1UPG34FoxZBp3lVcvK0LkgUz6VLk,88
+autodocgenerator-0.8.9.8.dist-info/RECORD,,