Index

A

admin_auth_config_error() (in module src.admin.security) ADMIN_CSRF_COOKIE (in module src.admin.settings) ADMIN_PASSWORD (in module src.admin.settings) ADMIN_SECRET_KEY (in module src.admin.settings) ADMIN_SESSION_COOKIE (in module src.admin.settings) ADMIN_SESSION_MAX_AGE (in module src.admin.settings) ADMIN_USERNAME (in module src.admin.settings) analyse_docstring_in_blocks() (in module src.utils.docstring_validation) analyse_docstring_in_module() (in module src.utils.docstring_validation) analyse_repo() (in module src.services.doc_services) AnalysisGap (class in src.services.architecture_services) app (in module src.main) apply_approved_architecture_document() (in module src.services.sphinx_services) apply_architecture_approval() (in module src.services.architecture_services) approval_note (src.models.repo_request.ArchitectureApprovalRequest attribute) approve_architecture_docs() (in module src.router.router)

architecture_draft_paths() (in module src.services.architecture_services) ArchitectureAnalysisError ArchitectureApprovalError ArchitectureApprovalRequest (class in src.models.repo_request) ArchitectureFinding (class in src.services.architecture_services) ArchitectureGenerationRequest (class in src.models.repo_request) ArchitectureOverwriteRequiredError ArchitectureSection (class in src.services.architecture_services) artifact_dir (src.admin.models.RunRecord attribute) (src.services.workflow_service.WorkflowRunResult attribute) AUTOAPI_ADD_TOCTREE_LINE (in module src.utils.update_conf_content) AUTOAPI_CONF_MARKER_END (in module src.services.sphinx_services) AUTOAPI_CONF_MARKER_START (in module src.services.sphinx_services) AUTOAPI_DIRECTORY (in module src.config.config) AUTOAPI_DIRS_LINE (in module src.utils.update_conf_content) AUTOAPI_DOCSTRING_THRESHOLD (in module src.services.sphinx_services) AUTOAPI_WARNINGS_TO_SUPPRESS (in module src.services.sphinx_services)

B

Base (class in src.admin.database) base_branch (src.models.repo_request.DocstringPullRequestRequest attribute) BASE_DIR (in module src.admin.settings) bind_repo_log_dir() (in module src.config.log_config) bind_repo_run_log_dir() (in module src.utils.output_paths) branch (src.models.repo_request.ArchitectureApprovalRequest attribute) (src.models.repo_request.ArchitectureGenerationRequest attribute) (src.models.repo_request.PublishPagesRequest attribute) (src.models.repo_request.RepoRequest attribute)

BUILD_DIR (in module src.config.config) build_repo_output_dir() (in module src.utils.output_paths) build_repo_output_file() (in module src.utils.output_paths)

C

CANCEL_GRACE_SECONDS (in module src.admin.jobs) cancel_run() (in module src.admin.router) classification (src.services.architecture_services.ArchitectureFinding attribute) clear_admin_session() (in module src.admin.security) clear_repo_output_history() (in module src.utils.output_paths) clear_runs() (in module src.admin.router) CLI_TIMEOUT_SECONDS (in module src.utils.docstring_generation) clone_repository() (in module src.utils.git_utils) code (src.services.docstring_pr_services.DocstringInsertion attribute) code_block_extractor() (src.utils.code_block_extraction.GenericCodeBlockExtractor method) commit_files_to_github_branch() (in module src.utils.git_utils) completed_at (src.admin.models.RunRecord attribute) CONF_PY (in module src.config.config) confidence_level (src.services.architecture_services.ArchitectureFinding attribute) (src.services.architecture_services.ArchitectureSection attribute) CONFIGURATION_UPDATE_FILE (in module src.config.config)

configure_github_pages() (in module src.utils.git_utils) configure_openai() (in module src.utils.docstring_generation) content (src.services.docstring_pr_services.PatchedPythonFile attribute) create_a_file() (in module src.utils.git_utils) create_admin_session() (in module src.admin.security) create_directory_and_add_files() (in module src.utils.git_utils) create_docstring_prompt() (in module src.utils.docstring_generation) create_github_blob() (in module src.utils.git_utils) create_github_pull_request() (in module src.utils.git_utils) create_openai_docstring_prompt() (in module src.utils.docstring_generation) create_python_docstring_pull_request() (in module src.services.docstring_pr_services) create_repository() (in module src.admin.router) create_sphinx_setup() (in module src.services.sphinx_services) created_at (src.admin.models.RepositoryConfig attribute) (src.admin.models.RunRecord attribute) CURRENT_PROCESS (in module src.admin.jobs) CURRENT_RUN_ID (in module src.admin.jobs)

D

dashboard() (in module src.admin.router) DATA_DIR (in module src.admin.settings) DATABASE_URL (in module src.admin.settings) decrypt_token() (in module src.admin.security) DEFAULT_ARCHITECTURE_OUTPUT_PATH (in module src.admin.router) DEFAULT_AUTOAPI_IGNORE_PATTERNS (in module src.services.sphinx_services) default_branch (src.admin.models.RepositoryConfig attribute) DEFAULT_CLAUDE_COMMAND (in module src.utils.docstring_generation) DEFAULT_CODEX_COMMAND (in module src.utils.docstring_generation) DEFAULT_GIT_CLONE_TIMEOUT_SECONDS (in module src.utils.git_utils) DEFAULT_OPENAI_MODEL (in module src.admin.settings) (in module src.utils.docstring_generation) delete_repository() (in module src.admin.router) description (src.services.architecture_services.AnalysisGap attribute) (src.services.architecture_services.ArchitectureFinding attribute) detect_navigation_conflict() (in module src.services.sphinx_services) DISPATCHER_LOCK (in module src.admin.jobs)

DISPATCHER_THREAD (in module src.admin.jobs) DOCS_ASSET_DIR (in module src.services.sphinx_services) DOCS_SCAFFOLD_DIR (in module src.services.sphinx_services) DOCS_SRC (in module src.config.config) docstring_threshold (src.admin.models.RepositoryConfig attribute) (src.models.repo_request.RepoRequest attribute) DocstringInsertion (class in src.services.docstring_pr_services) DocstringNode (in module src.services.docstring_pr_services) DocstringPullRequestError DocstringPullRequestRequest (class in src.models.repo_request) documentation_url (src.admin.models.RunRecord attribute) (src.services.workflow_service.WorkflowRunResult attribute) download_artifact() (in module src.admin.router) download_github_branch_snapshot() (in module src.utils.git_utils) draft_id (src.models.repo_request.ArchitectureApprovalRequest attribute) (src.services.workflow_service.WorkflowRunResult attribute) duration_seconds (src.admin.models.RunRecord attribute)

E

encrypt_token() (in module src.admin.security) encrypted_token (src.admin.models.RepositoryConfig attribute) endpoint (src.admin.jobs.QueuedJob attribute) (src.admin.models.RunRecord attribute) ENDPOINT_LABELS (in module src.admin.router) engine (in module src.admin.database) enqueue_run() (in module src.admin.jobs) ensure_csrf_token() (in module src.admin.security) ensure_github_branch() (in module src.utils.git_utils)

env_path (in module src.main) error_message (src.admin.models.RunRecord attribute) evidence_paths (src.services.architecture_services.ArchitectureFinding attribute) execute_architecture_approval_request() (in module src.services.workflow_service) execute_architecture_generation_request() (in module src.services.workflow_service) execute_docstring_pr_request() (in module src.services.workflow_service) execute_generate_request() (in module src.services.workflow_service) execute_publish_request() (in module src.services.workflow_service) EXT_LANGUAGE_MAP (src.utils.code_block_extraction.GenericCodeBlockExtractor attribute) extract_repo_path() (in module src.utils.git_utils)

F

fetch_content_bytes_from_github() (in module src.utils.git_utils) fetch_content_from_github() (in module src.utils.git_utils) fetch_content_from_gitlab() (in module src.utils.git_utils) fetch_repo_tree() (in module src.utils.git_utils) file_content (src.utils.code_block_extraction.GenericCodeBlockExtractor attribute)

file_name (src.utils.code_block_extraction.GenericCodeBlockExtractor attribute) find_architecture_draft() (in module src.services.architecture_services) find_latest_repo_run_dir() (in module src.utils.output_paths) finding_type (src.services.architecture_services.ArchitectureFinding attribute) findings (src.services.architecture_services.ArchitectureSection attribute) format_docstring_for_language() (in module src.utils.docstring_generation)

G

gap_type (src.services.architecture_services.AnalysisGap attribute) gaps (src.services.architecture_services.ArchitectureSection attribute) generate_architecture_docs() (in module src.router.router) generate_architecture_draft() (in module src.services.architecture_services) generate_docs() (in module src.router.router) generate_docstring() (in module src.utils.docstring_generation) generate_docstring_with_openai() (in module src.utils.docstring_generation) generate_docstrings_for_code_blocks_openai() (in module src.utils.docstring_generation) generate_draft_id() (in module src.services.architecture_services) generate_github_actions_file() (in module src.utils.generate_yml_content) generate_github_pages_index() (in module src.utils.generate_yml_content) generate_gitlab_ci_file() (in module src.utils.generate_yml_content)

GenericCodeBlockExtractor (class in src.utils.code_block_extraction) get_gitignore_patterns() (in module src.utils.git_utils) get_logger() (in module src.config.log_config) get_or_create_csrf_token() (in module src.admin.security) get_run_log_dir() (in module src.config.log_config) GITHUB_API_URL (in module src.config.config) GITHUB_PAGES_BRANCH (in module src.config.config) GITHUB_PAGES_INDEX_FILE (in module src.config.config) GITHUB_PAGES_NOJEKYLL_FILE (in module src.config.config) GITHUB_PAGES_PATH (in module src.config.config) GitHubApiError GITLAB_API_URL (in module src.config.config) GITLAB_YML_FILE (in module src.config.config)

I

id (src.admin.models.RepositoryConfig attribute) (src.admin.models.RunRecord attribute) include_diagrams (src.models.repo_request.ArchitectureGenerationRequest attribute) indent (src.services.docstring_pr_services.DocstringInsertion attribute)

inferred_count (src.services.architecture_services.ArchitectureSection property) init_db() (in module src.admin.database) insert_index (src.services.docstring_pr_services.DocstringInsertion attribute) inserted (src.services.docstring_pr_services.PatchedPythonFile attribute) is_autodoc_generated_content() (in module src.services.architecture_services)

J

JOB_QUEUE (in module src.admin.jobs)

K

kind (src.services.docstring_pr_services.DocstringInsertion attribute)

L

language (src.utils.code_block_extraction.GenericCodeBlockExtractor attribute) LANGUAGE_PATTERNS (src.utils.code_block_extraction.GenericCodeBlockExtractor attribute) line_number (src.services.docstring_pr_services.DocstringInsertion attribute) list_github_pull_request_files() (in module src.utils.git_utils) list_github_tree() (in module src.utils.git_utils) list_open_github_pull_requests() (in module src.utils.git_utils) list_repository_files() (in module src.utils.git_utils) LOG_DIR (in module src.config.log_config) LOG_FILE (in module src.config.log_config) LOG_FORMAT (in module src.config.log_config) LOG_LEVEL (in module src.config.log_config) log_path (src.admin.models.RunRecord attribute) (src.services.workflow_service.WorkflowRunResult attribute) LOG_RETENTION_COUNT (in module src.utils.output_paths)

logger (in module src.main) (in module src.router.router) (in module src.services.docstring_pr_services) (in module src.services.sphinx_services) (in module src.utils.docstring_generation) (in module src.utils.docstring_validation) (in module src.utils.git_utils) login_page() (in module src.admin.router) login_submit() (in module src.admin.router) logout() (in module src.admin.router) low_content_min_lines (src.admin.models.RepositoryConfig attribute) (src.models.repo_request.PublishPagesRequest attribute) (src.models.repo_request.RepoRequest attribute) LOW_CONTENT_MIN_MEANINGFUL_LINES (in module src.services.sphinx_services)

M

MANUAL_EDIT_MARKER (in module src.services.architecture_services) MAX_ACTIVITY_ITEMS (in module src.admin.settings) max_docstrings (src.models.repo_request.DocstringPullRequestRequest attribute) metrics_docstrings_generated (src.admin.models.RunRecord attribute) (src.services.workflow_service.WorkflowRunResult attribute) metrics_files_analyzed (src.admin.models.RunRecord attribute) (src.services.workflow_service.WorkflowRunResult attribute) metrics_skipped_files (src.admin.models.RunRecord attribute) (src.services.workflow_service.WorkflowRunResult attribute) model (src.models.repo_request.ArchitectureGenerationRequest attribute) (src.models.repo_request.RepoRequest attribute) module src src.admin src.admin.database src.admin.jobs src.admin.models src.admin.router src.admin.security src.admin.settings src.config src.config.config src.config.log_config src.main src.models src.models.repo_request src.router src.router.router src.services src.services.architecture_services src.services.doc_services src.services.docstring_pr_services src.services.sphinx_services src.services.workflow_service src.utils src.utils.code_block_extraction src.utils.docstring_generation src.utils.docstring_validation src.utils.generate_yml_content src.utils.git_utils src.utils.output_paths src.utils.update_conf_content

N

name (src.admin.models.RepositoryConfig attribute) (src.services.architecture_services.ArchitectureFinding attribute) (src.services.docstring_pr_services.DocstringInsertion attribute)

O

observed_count (src.services.architecture_services.ArchitectureSection property) output_path (src.models.repo_request.ArchitectureApprovalRequest attribute) (src.models.repo_request.ArchitectureGenerationRequest attribute)

overwrite_existing (src.models.repo_request.ArchitectureApprovalRequest attribute)

P

patch_python_docstrings() (in module src.services.docstring_pr_services) PatchedPythonFile (class in src.services.docstring_pr_services) payload (src.admin.jobs.QueuedJob attribute) PIPELINE_EMAIL (in module src.config.config) PIPELINE_USERNAME (in module src.config.config) preferred_model (src.admin.models.RepositoryConfig attribute) preview_artifact() (in module src.admin.router) PROCESS_LOCK (in module src.admin.jobs) progress_message (src.admin.models.RunRecord attribute) progress_percent (src.admin.models.RunRecord attribute) PROJECT_AUTHOR (in module src.config.config) PROJECT_NAME (in module src.config.config) propose_architecture_navigation() (in module src.services.sphinx_services)

provider (src.admin.models.RepositoryConfig attribute) (src.models.repo_request.ArchitectureApprovalRequest attribute) (src.models.repo_request.ArchitectureGenerationRequest attribute) (src.models.repo_request.DocstringPullRequestRequest attribute) (src.models.repo_request.RepoRequest attribute) publish_github_directory_to_branch() (in module src.utils.git_utils) publish_github_pages() (in module src.services.sphinx_services) publish_local_directory_to_github_branch() (in module src.utils.git_utils) publish_pages() (in module src.router.router) published_branch (src.admin.models.RunRecord attribute) (src.services.workflow_service.WorkflowRunResult attribute) PublishPagesError PublishPagesRequest (class in src.models.repo_request)

Q

QUEUE_CONDITION (in module src.admin.jobs)

QueuedJob (class in src.admin.jobs)

R

read_admin_session() (in module src.admin.security) read_file_bytes_from_local() (in module src.utils.git_utils) read_file_content_from_local() (in module src.utils.git_utils) recent_activity_fragment() (in module src.admin.router) recommended_review_action (src.services.architecture_services.AnalysisGap attribute) reconcile_interrupted_runs() (in module src.admin.jobs) recovered_runs (in module src.main) repo_path (src.admin.models.RepositoryConfig attribute) repo_url (src.admin.models.RepositoryConfig attribute) (src.models.repo_request.ArchitectureApprovalRequest attribute) (src.models.repo_request.ArchitectureGenerationRequest attribute) (src.models.repo_request.DocstringPullRequestRequest attribute) (src.models.repo_request.PublishPagesRequest attribute) (src.models.repo_request.RepoRequest attribute) RepoAnalysisError RepoRequest (class in src.models.repo_request) repositories_page() (in module src.admin.router) repository (src.admin.models.RunRecord attribute) repository_detail() (in module src.admin.router) repository_edit_form() (in module src.admin.router) repository_id (src.admin.models.RunRecord attribute) repository_new_form() (in module src.admin.router) RepositoryAccessError RepositoryConfig (class in src.admin.models) request_github_pages_build() (in module src.utils.git_utils)

request_payload (src.admin.models.RunRecord attribute) request_run_cancellation() (in module src.admin.jobs) require_admin() (in module src.admin.security) REQUIRED_EXTENSIONS (in module src.utils.update_conf_content) resolve_ai_provider() (in module src.utils.docstring_generation) response (src.services.workflow_service.WorkflowRunResult attribute) RESTART_EXIT_MESSAGE (in module src.admin.jobs) RESTART_QUEUE_MESSAGE (in module src.admin.jobs) result_payload (src.admin.models.RunRecord attribute) retry_run() (in module src.admin.router) reuse_doc (src.admin.models.RepositoryConfig attribute) (src.models.repo_request.RepoRequest attribute) reuse_existing_docs (src.models.repo_request.ArchitectureGenerationRequest attribute) RISKY_AUTOAPI_PATH_PATTERNS (in module src.services.sphinx_services) root() (in module src.router.router) router (in module src.admin.router) (in module src.router.router) run_detail() (in module src.admin.router) run_id (src.admin.jobs.QueuedJob attribute) RUN_LOG_DIR (in module src.config.log_config) run_row_fragment() (in module src.admin.router) run_status_fragment() (in module src.admin.router) RUN_TIMESTAMP (in module src.config.log_config) RunRecord (class in src.admin.models) runs (src.admin.models.RepositoryConfig attribute) runs_page() (in module src.admin.router)

S

SAMPLE_DOCS_FALLBACK_TEXTS (in module src.services.sphinx_services) scrub_sensitive_run_payloads() (in module src.admin.database) section_name (src.services.architecture_services.AnalysisGap attribute) (src.services.architecture_services.ArchitectureSection attribute) SECTION_NAMES (in module src.services.architecture_services) SENSITIVE_PAYLOAD_FIELDS (in module src.admin.router) SessionLocal (in module src.admin.database) set_admin_session() (in module src.admin.security) should_ignore() (in module src.utils.git_utils) source_branch (src.admin.models.RunRecord attribute) (src.services.workflow_service.WorkflowRunResult attribute) SPHINX_CONF_CANDIDATES (in module src.services.sphinx_services) SQLITE_PATH (in module src.admin.settings) src module src.admin module src.admin.database module src.admin.jobs module src.admin.models module src.admin.router module src.admin.security module src.admin.settings module src.config module src.config.config module src.config.log_config module src.main module src.models module src.models.repo_request module src.router module src.router.router module

src.services module src.services.architecture_services module src.services.doc_services module src.services.docstring_pr_services module src.services.sphinx_services module src.services.workflow_service module src.utils module src.utils.code_block_extraction module src.utils.docstring_generation module src.utils.docstring_validation module src.utils.generate_yml_content module src.utils.git_utils module src.utils.output_paths module src.utils.update_conf_content module started_at (src.admin.models.RunRecord attribute) status (src.admin.models.RunRecord attribute) (src.services.architecture_services.ArchitectureSection attribute) status_code (src.services.architecture_services.ArchitectureAnalysisError attribute) (src.services.architecture_services.ArchitectureApprovalError attribute) (src.services.doc_services.RepoAnalysisError attribute) (src.services.sphinx_services.PublishPagesError attribute) (src.utils.git_utils.GitHubApiError attribute) (src.utils.git_utils.RepositoryAccessError attribute) suggest_python_docstrings_pr() (in module src.router.router) suggestion_branch (src.models.repo_request.DocstringPullRequestRequest attribute) summary (src.services.architecture_services.ArchitectureSection attribute) summary_output (src.admin.models.RunRecord attribute) (src.services.workflow_service.WorkflowRunResult attribute) SUPPORTED_AI_PROVIDERS (in module src.utils.docstring_generation)

T

target_folders (src.admin.models.RepositoryConfig property) (src.models.repo_request.ArchitectureGenerationRequest attribute) (src.models.repo_request.RepoRequest attribute) target_folders_json (src.admin.models.RepositoryConfig attribute) templates (in module src.admin.router) TEMPLATES_DIR (in module src.admin.settings) title (src.models.repo_request.DocstringPullRequestRequest attribute) to_dict() (src.services.architecture_services.AnalysisGap method) (src.services.architecture_services.ArchitectureFinding method) to_summary_dict() (src.services.architecture_services.ArchitectureSection method) token (src.models.repo_request.ArchitectureApprovalRequest attribute) (src.models.repo_request.ArchitectureGenerationRequest attribute) (src.models.repo_request.DocstringPullRequestRequest attribute) (src.models.repo_request.PublishPagesRequest attribute) (src.models.repo_request.RepoRequest attribute)

token_last4 (src.admin.models.RepositoryConfig attribute) TOKEN_REQUIRED_ENDPOINTS (in module src.admin.router) trigger_approve_architecture_docs() (in module src.admin.router) trigger_generate() (in module src.admin.router) trigger_generate_architecture_docs() (in module src.admin.router) trigger_gitlab_pipeline() (in module src.services.sphinx_services) trigger_publish() (in module src.admin.router) trigger_suggest_pr() (in module src.admin.router) triggered_by (src.admin.models.RunRecord attribute)

U

UNEXPECTED_EXIT_MESSAGE (in module src.admin.jobs) update_conf() (in module src.utils.update_conf_content)

update_repository() (in module src.admin.router) update_sphinx_navigation_for_architecture() (in module src.services.sphinx_services) updated_at (src.admin.models.RepositoryConfig attribute)

V

validate_admin_credentials() (in module src.admin.security) validate_architecture_output_path() (in module src.utils.output_paths)

validate_docstring() (in module src.utils.git_utils) verify_csrf() (in module src.admin.security)

W

WorkflowRunResult (class in src.services.workflow_service)