autodocgenerator 0.9.0.0__py3-none-any.whl → 0.9.0.2__py3-none-any.whl

autodocgenerator/engine/config/config.py

@@ -9,28 +9,34 @@ You should understand, that it is not full code, it is just part
 Do NOT skip details; analyze everything that appears in the snippet.
 """
 
-BASE_PART_COMPLITE_TEXT = """Revised Documentation Prompt
-Role: You are a senior technical writer. Input: You will receive a specific code snippet representing a fragment of a larger system.
-Task: Write clear, structured, and hierarchical documentation for this fragment. Length: 0.7–1k characters (keep it tight).
-
-Content Requirements:
-Component Responsibility: Define exactly what this specific fragment does.
-Interactions: Describe how this piece communicates with the rest of the system.
-Technical Details: Detail key functions, classes, and logic flows present in the snippet.
-Data Flow: Outline inputs, outputs, side effects, and logic assumptions.
-
-Constraint - No Generic Headers (CRITICAL):
-DO NOT use generic or global topic headers such as "Overview," "Core," "Introduction," "Background," or "System Summary."
-All headings must be specific to the functionality of the code fragment provided.
-
-Context & Style:
-Use the global system description as the primary context, but do not restate it. Focus exclusively on the fragment.
-Write for developers who are new to the codebase.
-Maintain high technical accuracy and a concise, professional tone.
-
-Formatting:
-Use Markdown for structure.
-Include HTML anchors near titles: <a name="specific-title"></a> \n ## Specific Title."""
+BASE_PART_COMPLITE_TEXT = """
+Role: You are a Senior Technical Writer & System Architect. Objective: Create high-fidelity, visually polished, and strictly factual documentation for a specific code fragment.
+
+1. STRICT GROUNDING & ACCURACY (NO HALLUCINATIONS):
+Source Truth: Use ONLY the provided code snippet and the explicit global context.
+Zero Assumption Policy: If a function's origin, a variable's purpose, or a data source is not explicitly present in the provided text, do not invent it. If information is missing, omit the section or state: "Information not present in the provided fragment."
+Context Lock: Do not use general knowledge about external libraries unless their specific usage is visible in the code.
+
+2. VISUAL STRUCTURE & MD STYLE:
+Layout: Use a highly scannable, hierarchical Markdown structure.
+Data Visualization: Present Inputs, Outputs, and Parameters in a Markdown Table (Columns: Entity, Type, Role, Notes).
+Emphasis: Use backticks for code symbols, bolding for key terms, and > Blockquotes for critical logic assumptions or warnings.
+Navigation: Every heading must be preceded by an HTML anchor: <a name="unique-id"></a> \n ## Specific Heading.
+
+3. CONTENT REQUIREMENTS (0.7–1k characters):
+Specific Component Responsibility: Define the exact functional role of this fragment within the system.
+Visible Interactions: Describe how this piece communicates with other parts of the system based only on the snippet.
+Technical Logic Flow: A step-by-step breakdown of the classes, functions, and internal logic.
+Data Contract: Detailed flow of inputs, outputs, and side effects in table format.
+
+4. CRITICAL CONSTRAINT - NO GENERIC HEADERS:
+Forbidden: "Overview", "Introduction", "Background", "Technical Details", "Summary", "Core".
+Required: Use headers that describe the specific functionality (e.g., ## [Component Name] Request Validation or ## Stream Processing Pipeline).
+
+5. TONE & STYLE:
+Professional, technical, and laconic.
+Write for developers who need to understand the fragment's implementation instantly.
+Focus exclusively on the fragment; do not restate the global system description."""
 
 BASE_INTRODACTION_CREATE_LINKS = """
 Role: Senior Technical Solutions Architect.
@@ -106,7 +112,8 @@ BASE_CUSTOM_DISCRIPTIONS = """
                 3. DO NOT use external knowledge or invent any logic that is not present in the text.
                 4. Do not provide any introductory or concluding remarks. If there is no info, output must be empty.
                 5. If you dont have any info about it return just !noinfo
-                6. 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:
+                6. 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(This rules works only for <a name=""></a> tag):
 
 NO filenames or paths (e.g., forbidden: "autodocconfig.yml", "src/config").
 NO file extensions (e.g., forbidden: ".yml", ".md").

autodocgenerator/manage.py

@@ -67,15 +67,12 @@ class Manager:
         self.logger.log(InfoLog("Code mix generation completed."))
         self.progress_bar.update_task()
 
-
     def generete_doc_parts(self, max_symbols=5_000):
-
-
         full_code_mix = self.read_file_by_file_key("code_mix")
 
         self.logger.log(InfoLog("Starting synchronous documentation generation by parts..."))
         result = gen_doc_parts(full_code_mix,
-                                max_symbols, self.sync_model, 
+                                max_symbols, self.sync_model, self.config.get_project_settings(),
                                 self.config.language, self.progress_bar)
             
         self.logger.log(InfoLog("Documentation generation by parts completed."))

autodocgenerator/preprocessor/spliter.py

@@ -3,6 +3,7 @@ from ..engine.config.config import BASE_PART_COMPLITE_TEXT
 import asyncio
 from ..ui.progress_base import BaseProgress
 from ..ui.logging import BaseLogger, InfoLog, ErrorLog, WarningLog
+from .settings import ProjectSettings
 
 
 def split_data(data: str, max_symbols: int) -> list[str]:
@@ -40,13 +41,17 @@ def split_data(data: str, max_symbols: int) -> list[str]:
 
     return split_objects
 
-def write_docs_by_parts(part_id: int, part: str, model: Model, prev_info: str = None, language: str = "en"):
+def write_docs_by_parts(part: str, model: Model, project_settings: ProjectSettings, prev_info: str = None, language: str = "en"):
     logger = BaseLogger()
     logger.log(InfoLog("Generating documentation for a part..."))
     prompt = [
             {
                 "role": "system",
-                "content": f"For the following task use language {language}. your part id is {part_id}"
+                "content": f"For the following task use language {language}"
+            },
+            {
+                "role": "system",
+                "content": f"global project info: {project_settings.prompt}"
             },
             {
                 "role": "system",
@@ -89,10 +94,7 @@ async def async_write_docs_by_parts(part: str, async_model: AsyncModel, global_i
                 "role": "system",
                 "content": BASE_PART_COMPLITE_TEXT
             },
-            # {
-                # "role": "system",
-                # "content": global_info
-            # },
+           
             {
                 "role": "user",
                 "content": part
@@ -102,7 +104,7 @@ async def async_write_docs_by_parts(part: str, async_model: AsyncModel, global_i
         if prev_info is not None:
             prompt.append({
                     "role": "system",
-                    "content": f"it is last part of documentation that you have write before{prev_info}"
+                    "content": f"it is last part of documentation that you have write before {prev_info}"
                 })
 
         prompt.append({
@@ -124,7 +126,7 @@ async def async_write_docs_by_parts(part: str, async_model: AsyncModel, global_i
         return answer
 
 
-def gen_doc_parts(full_code_mix, max_symbols, model: Model, language, progress_bar: BaseProgress):
+def gen_doc_parts(full_code_mix, max_symbols, model: Model, project_settings: ProjectSettings,  language, progress_bar: BaseProgress):
     splited_data = split_data(full_code_mix, max_symbols)
     result = None
     logger = BaseLogger()
@@ -134,7 +136,7 @@ def gen_doc_parts(full_code_mix, max_symbols, model: Model, language, progress_b
     
     all_result = ""
     for i, el in enumerate(splited_data):
-        result = write_docs_by_parts(i + 1, el, model, result, language)
+        result = write_docs_by_parts(el, model, project_settings, result, language)
         all_result += result
         all_result += "\n\n"