Function index

codewiki/src/fe/visualise_docs.py:108–136

Serve the overview page as the main page.

()

@app.get("/", response_class=HTMLResponse)
async def index():
    """Serve the overview page as the main page."""
    initialize_globals()
    
    if DOCS_FOLDER is None:
        raise HTTPException(status_code=500, detail="Documentation folder not configured. Please set DOCS_FOLDER environment variable or run with --docs-folder argument.")
    
    overview_file = Path(DOCS_FOLDER) / "overview.md"
    
    if not overview_file.exists():
        raise HTTPException(status_code=404, detail="overview.md not found in the documentation folder")
    
    try:
        content = file_manager.load_text(overview_file)
        
        html_content = markdown_to_html(content)
        title = get_file_title(overview_file)
        
        context = {
            "title": title,
            "content": html_content,
            "navigation": MODULE_TREE,
            "current_page": "overview.md"
        }
        
        return HTMLResponse(content=render_template(DOCS_VIEW_TEMPLATE, context))
        
    except Exception as e:
        raise HTTPException(status_code=500, detail=f"Error reading overview.md: {e}")


@app.get("/{filename:path}", response_class=HTMLResponse)