{"library":"sphinx-sitemap","title":"Sphinx Sitemap Generator Extension","type":"library","description":"Sphinx-sitemap is a Sphinx extension designed to automatically generate sitemaps.org compliant XML sitemaps for the HTML version of your Sphinx documentation. It supports multi-version and multi-language documentation, enhances SEO, and can include 'last modified' timestamps. The current version is 2.9.0, released on October 5, 2025.","language":"python","status":"active","last_verified":"Sat May 16","install":{"commands":["pip install sphinx-sitemap"],"cli":null},"imports":["extensions = ['sphinx_sitemap']"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":null,"github":"https://github.com/jdillard/sphinx-sitemap","docs":"https://sphinx-sitemap.readthedocs.io/en/latest/index.html","changelog":"https://github.com/jdillard/sphinx-sitemap/blob/master/CHANGELOG.rst","pypi":"https://pypi.org/project/sphinx-sitemap/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"# In conf.py, typically located in your Sphinx project's root directory\n\nimport os\n\nproject = 'My Awesome Docs'\ncopyright = '2026, Your Name'\n\nextensions = [\n    'sphinx.ext.autodoc',\n    'sphinx.ext.napoleon',\n    'sphinx_sitemap',  # Add this line to enable the extension\n]\n\n# *** ESSENTIAL for sitemap generation ***\n# Set the base URL of your published documentation. This is critical for sitemap validity.\nhtml_baseurl = os.environ.get('DOCS_BASE_URL', 'https://example.com/docs/')\n\n# Optional: Enable 'lastmod' timestamps (requires Git repository with history)\n# sitemap_show_lastmod = True\n\n# Optional: Exclude specific pages or patterns from the sitemap\n# sitemap_exclude_pages = ['excluded_page.html', '**/private/*']\n\n# To generate the sitemap, navigate to your docs directory and run:\n# sphinx-build -b html . _build\n# The sitemap.xml will be generated in the _build directory.","lang":"python","description":"To get started, install the library and then enable the extension by adding 'sphinx_sitemap' to the `extensions` list in your Sphinx `conf.py`. Crucially, set the `html_baseurl` configuration variable to the root URL where your documentation will be hosted for correct sitemap generation.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-16","installed_version":"2.9.0","pypi_latest":"2.9.0","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":5.5,"avg_import_s":0,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"sphinx-sitemap","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0,"mem_mb":0,"disk_size":"92.2M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"sphinx-sitemap","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.5,"import_time_s":0,"mem_mb":0,"disk_size":"93M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"sphinx-sitemap","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0,"mem_mb":0,"disk_size":"101.4M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"sphinx-sitemap","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.4,"import_time_s":0,"mem_mb":0,"disk_size":"102M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"sphinx-sitemap","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0,"mem_mb":0,"disk_size":"92.4M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"sphinx-sitemap","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.2,"import_time_s":0,"mem_mb":0,"disk_size":"93M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"sphinx-sitemap","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0,"mem_mb":0,"disk_size":"92.3M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"sphinx-sitemap","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.2,"import_time_s":0,"mem_mb":0,"disk_size":"93M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"sphinx-sitemap","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0,"mem_mb":0,"disk_size":"91.6M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"sphinx-sitemap","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":6.4,"import_time_s":0,"mem_mb":0,"disk_size":"92M"}]}}