Function main

codewiki/src/fe/visualise_docs.py:188–264

Main function to run the documentation server.

()

def main():
    """Main function to run the documentation server."""
    parser = argparse.ArgumentParser(
        description="Simple documentation server for hosting markdown documentation folders"
    )
    parser.add_argument(
        "--docs-folder",
        type=str,
        required=True,
        help="Path to the documentation folder containing markdown files and module_tree.json"
    )
    parser.add_argument(
        "--port",
        type=int,
        default=8000,
        help="Port to run the server on (default: 8000)"
    )
    parser.add_argument(
        "--host",
        type=str,
        default="127.0.0.1",
        help="Host to bind the server to (default: 127.0.0.1)"
    )
    parser.add_argument(
        "--debug",
        action="store_true",
        help="Run the server in debug mode"
    )
    
    args = parser.parse_args()
    
    # Validate docs folder
    docs_folder = Path(args.docs_folder)
    if not docs_folder.exists():
        print(f"Error: Documentation folder '{docs_folder}' does not exist")
        sys.exit(1)
    
    if not docs_folder.is_dir():
        print(f"Error: '{docs_folder}' is not a directory")
        sys.exit(1)
    
    # Check for overview.md
    overview_file = docs_folder / "overview.md"
    if not overview_file.exists():
        print(f"Warning: overview.md not found in '{docs_folder}'")
    
    # Set global variables and environment variable for uvicorn reload
    global DOCS_FOLDER, MODULE_TREE
    DOCS_FOLDER = str(docs_folder.resolve())
    MODULE_TREE = load_module_tree(docs_folder)
    
    # Set environment variable so uvicorn reload can pick it up
    import os
    os.environ['DOCS_FOLDER'] = DOCS_FOLDER
    
    print(f"📚 Starting documentation server...")
    print(f"📁 Documentation folder: {DOCS_FOLDER}")
    print(f"🌐 Server running at: http://{args.host}:{args.port}")