{"library":"sphinxcontrib-websupport","title":"Sphinx Contrib WebSupport","type":"library","description":"sphinxcontrib-websupport provides a Python API to easily integrate Sphinx documentation into your Web application. It facilitates building Sphinx documentation in a web-friendly format and retrieving content. The current version is 2.0.0, and releases are infrequent but can include significant breaking changes between major versions.","language":"python","status":"active","last_verified":"Fri May 22","install":{"commands":["pip install sphinxcontrib-websupport"],"cli":null},"imports":["from sphinxcontrib.websupport import WebSupport"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":"https://www.sphinx-doc.org/","github":"https://github.com/sphinx-doc/sphinxcontrib-websupport","docs":null,"changelog":"https://github.com/sphinx-doc/sphinxcontrib-websupport/blob/master/CHANGES.rst","pypi":"https://pypi.org/project/sphinxcontrib-websupport/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"import os\nfrom pathlib import Path\nfrom sphinxcontrib.websupport import WebSupport\n\n# Create dummy Sphinx project directories for the example\nsrc_dir = Path('./docs-src')\nbuild_dir = Path('./docs-build')\n\nsrc_dir.mkdir(exist_ok=True)\nbuild_dir.mkdir(exist_ok=True)\n\n# Create a minimal conf.py and index.rst\n(src_dir / 'conf.py').write_text(\n    \"\"\"project = 'My Web Docs'\\ncopyright = '2023, Me'\\nhtml_theme = 'alabaster'\\n\"\"\"\n)\n(src_dir / 'index.rst').write_text(\n    \"\"\"Welcome to My Web Docs\\n=======================\n\n.. toctree::\n   :maxdepth: 2\n\n   intro\n\"\"\"\n)\n(src_dir / 'intro.rst').write_text(\"\"\"Introduction\\n============\\nThis is an introduction.\"\"\"\n)\n\ntry:\n    # Initialize WebSupport with source and build directories\n    # The build_dir must exist and be writable.\n    support = WebSupport(srcdir=str(src_dir), builddir=str(build_dir))\n\n    # Build all documents\n    print(\"Building documents...\")\n    support.build_all()\n    print(f\"Documents built to: {build_dir}\")\n\n    # Retrieve a specific document (e.g., 'index')\n    print(\"Retrieving 'index' document...\")\n    document = support.get_document('index')\n\n    print(\"\\n--- Document HTML Snippet ---\")\n    print(document.get('body', '')[:200] + '...') # Print first 200 chars of body\n    print(\"\\n--- Document Title ---\")\n    print(document.get('title'))\n\nexcept Exception as e:\n    print(f\"An error occurred: {e}\")\nfinally:\n    # Clean up dummy directories\n    import shutil\n    if src_dir.exists():\n        shutil.rmtree(src_dir)\n    if build_dir.exists():\n        shutil.rmtree(build_dir)\n","lang":"python","description":"This quickstart demonstrates how to initialize `WebSupport`, build Sphinx documentation, and retrieve generated content. It creates a dummy Sphinx project, builds it using `WebSupport.build_all()`, and then fetches the content of the 'index' page.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-22","installed_version":"2.0.0","pypi_latest":"2.0.0","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":5.3,"avg_import_s":1.05,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"sphinxcontrib-websupport","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.98,"mem_mb":24.7,"disk_size":"92.4M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"sphinxcontrib-websupport","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5,"import_time_s":0.9,"mem_mb":24.7,"disk_size":"93M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"sphinxcontrib-websupport","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":1.4,"mem_mb":26.4,"disk_size":"101.6M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"sphinxcontrib-websupport","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.2,"import_time_s":1.27,"mem_mb":26.4,"disk_size":"102M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"sphinxcontrib-websupport","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":1.15,"mem_mb":26.1,"disk_size":"92.6M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"sphinxcontrib-websupport","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5,"import_time_s":1.26,"mem_mb":26.1,"disk_size":"93M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"sphinxcontrib-websupport","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":1.05,"mem_mb":26.1,"disk_size":"92.5M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"sphinxcontrib-websupport","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.1,"import_time_s":1.14,"mem_mb":26.1,"disk_size":"93M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"sphinxcontrib-websupport","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.69,"mem_mb":24.2,"disk_size":"91.7M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"sphinxcontrib-websupport","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":6.1,"import_time_s":0.65,"mem_mb":24.2,"disk_size":"92M"}]}}