{"library":"sphinxcontrib-bibtex","title":"Sphinxcontrib-BibTeX","type":"library","description":"Sphinxcontrib-bibtex is a Sphinx extension that enables BibTeX-style citations in documentation. It allows users to insert citations via roles like `:cite:p:` and `:cite:t:` and generate bibliographies using a `.. bibliography::` directive, similar to LaTeX's `thebibliography` environment. The library is currently at version 2.6.5 and maintains an active development and release cadence.","language":"python","status":"active","last_verified":"Fri May 15","install":{"commands":["pip install sphinxcontrib-bibtex"],"cli":null},"imports":["extensions = [\n    'sphinx.ext.autodoc',\n    'sphinxcontrib.bibtex'\n]"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":null,"github":"https://github.com/mcmtroffaes/sphinxcontrib-bibtex","docs":null,"changelog":null,"pypi":"https://pypi.org/project/sphinxcontrib-bibtex/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"# conf.py\nimport os\nimport sys\n\nproject = 'My Project'\ncopyright = '2026, Author'\n\nextensions = [\n    'sphinx.ext.autodoc',\n    'sphinx.ext.napoleon',\n    'sphinxcontrib.bibtex',\n]\n\n# Configure paths to your BibTeX files\nbibtex_bibfiles = ['refs.bib']\n\n# Optional: Set a default referencing style (e.g., 'author_year')\n# bibtex_reference_style = 'author_year'\n\n# index.rst (or any .rst file)\n\"\"\"\n.. _index:\n\nWelcome to My Project's Documentation!\n======================================\n\nThis is a demonstration of ``sphinxcontrib-bibtex``.\n\nHere's a textual citation: See :cite:t:`1987:nelson` for an introduction to non-standard analysis.\nAnd here's a parenthetical one: Non-standard analysis is fun :cite:p:`1987:nelson`.\n\nReferences\n----------\n\n.. bibliography::\n   :all:\n   :max_citation_text_length: 80\n\"\"\"\n\n# refs.bib\n\"\"\"\n@Book{1987:nelson,\n  author = {Edward Nelson},\n  title = {Radically Elementary Probability Theory},\n  publisher = {Princeton University Press},\n  year = {1987}\n}\n\"\"\"","lang":"python","description":"To quickly set up `sphinxcontrib-bibtex`, first install it via pip. Then, modify your `conf.py` to add `'sphinxcontrib.bibtex'` to your `extensions` list and specify your BibTeX files using `bibtex_bibfiles`. Create a `.bib` file (e.g., `refs.bib`) with your entries. Finally, use `:cite:t:` (textual), `:cite:p:` (parenthetical) roles, and the `.. bibliography::` directive in your reStructuredText files to cite and display your references.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-15","installed_version":"2.6.5","pypi_latest":"2.7.0","is_stale":true,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":5.8,"avg_import_s":null,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"sphinxcontrib-bibtex","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"95.9M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"sphinxcontrib-bibtex","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":5.5,"import_time_s":null,"mem_mb":null,"disk_size":"97M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"sphinxcontrib-bibtex","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"105.5M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"sphinxcontrib-bibtex","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":5.8,"import_time_s":null,"mem_mb":null,"disk_size":"107M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"sphinxcontrib-bibtex","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"96.4M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"sphinxcontrib-bibtex","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":5.6,"import_time_s":null,"mem_mb":null,"disk_size":"98M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"sphinxcontrib-bibtex","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"96.4M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"sphinxcontrib-bibtex","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":5.5,"import_time_s":null,"mem_mb":null,"disk_size":"98M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"sphinxcontrib-bibtex","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":"95.2M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"sphinxcontrib-bibtex","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":6.7,"import_time_s":null,"mem_mb":null,"disk_size":"96M"}]}}