# `sphinx-pybtex-etal-style`
[](https://pypi.org/project/sphinx-pybtex-etal-style)
[](https://pypi.org/project/sphinx-pybtex-etal-style)
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://open.vscode.dev/ComPWA/sphinx-pybtex-etal-style)
[](https://github.com/ComPWA/sphinx-pybtex-etal-style/actions?query=branch%3Amain+workflow%3ACI)
[](https://mypy.readthedocs.io)
[](https://results.pre-commit.ci/latest/github/ComPWA/sphinx-pybtex-etal-style/main)
[](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)
[](https://github.com/prettier/prettier)
[](https://github.com/psf/black)
[](https://github.com/astral-sh/ruff)
This Sphinx extension defines a new bibliography style for the [`sphinxcontrib-bibtex`](https://sphinxcontrib-bibtex.rtfd.io) extension. Install through [PyPI](https://pypi.org) with `pip`:
```bash
pip install sphinx-pybtex-etal-style
```
Next, in your [Sphinx configuration file](https://www.sphinx-doc.org/en/master/usage/configuration.html) (`conf.py`), add `"sphinx_pybtex_etal_style"` to your `extensions`:
```python
extensions = [
"sphinx_pybtex_etal_style",
]
```
and set your [default bibliography style](https://sphinxcontrib-bibtex.readthedocs.io/en/stable/usage.html#bibliography-style) to `"unsrt_et_al"`:
```python
bibtex_default_style = "unsrt_et_al"
```
Alternatively, you can use the style for one bibliography only by specifying it in the [`.. bibliography::` directive](https://sphinxcontrib-bibtex.readthedocs.io/en/stable/usage.html#directive-bibliography):
```rst
.. bibliography:: /references.bib
:style: unsrt_et_al
```
Book entries that have an ISBN get a link to the book entry on [bookfinder.com](https://bookfinder.com/search). If you want to use [isbnsearch.org](https://isbnsearch.org) instead, add the following to your `conf.py`:
```python
unsrt_etal_isbn_resolver = "isbnsearch"
```
Raw data
{
"_id": null,
"home_page": "",
"name": "sphinx-pybtex-etal-style",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "compwa-admin@ep1.rub.de",
"keywords": "bibliography,bibtex,sphinx",
"author": "",
"author_email": "Common Partial Wave Analysis <compwa-admin@ep1.rub.de>",
"download_url": "https://files.pythonhosted.org/packages/f4/7e/cd4ed20410244e978ae28ec33f9085000224dbf336c3530a00afc46c05cb/sphinx-pybtex-etal-style-0.0.2.tar.gz",
"platform": null,
"description": "# `sphinx-pybtex-etal-style`\n\n[](https://pypi.org/project/sphinx-pybtex-etal-style)\n[](https://pypi.org/project/sphinx-pybtex-etal-style)\n[](https://opensource.org/licenses/BSD-3-Clause)\n[](https://open.vscode.dev/ComPWA/sphinx-pybtex-etal-style)\n[](https://github.com/ComPWA/sphinx-pybtex-etal-style/actions?query=branch%3Amain+workflow%3ACI)\n[](https://mypy.readthedocs.io)\n[](https://results.pre-commit.ci/latest/github/ComPWA/sphinx-pybtex-etal-style/main)\n[](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)\n[](https://github.com/prettier/prettier)\n[](https://github.com/psf/black)\n[](https://github.com/astral-sh/ruff)\n\nThis Sphinx extension defines a new bibliography style for the [`sphinxcontrib-bibtex`](https://sphinxcontrib-bibtex.rtfd.io) extension. Install through [PyPI](https://pypi.org) with `pip`:\n\n```bash\npip install sphinx-pybtex-etal-style\n```\n\nNext, in your [Sphinx configuration file](https://www.sphinx-doc.org/en/master/usage/configuration.html) (`conf.py`), add `\"sphinx_pybtex_etal_style\"` to your `extensions`:\n\n```python\nextensions = [\n \"sphinx_pybtex_etal_style\",\n]\n```\n\nand set your [default bibliography style](https://sphinxcontrib-bibtex.readthedocs.io/en/stable/usage.html#bibliography-style) to `\"unsrt_et_al\"`:\n\n```python\nbibtex_default_style = \"unsrt_et_al\"\n```\n\nAlternatively, you can use the style for one bibliography only by specifying it in the [`.. bibliography::` directive](https://sphinxcontrib-bibtex.readthedocs.io/en/stable/usage.html#directive-bibliography):\n\n```rst\n.. bibliography:: /references.bib\n :style: unsrt_et_al\n```\n\nBook entries that have an ISBN get a link to the book entry on [bookfinder.com](https://bookfinder.com/search). If you want to use [isbnsearch.org](https://isbnsearch.org) instead, add the following to your `conf.py`:\n\n```python\nunsrt_etal_isbn_resolver = \"isbnsearch\"\n```\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "Abbreviate long author lists with et al. in BibTeX bibliographies for Sphinx",
"version": "0.0.2",
"project_urls": {
"Changelog": "https://github.com/ComPWA/sphinx-pybtex-etal-style/releases",
"Documentation": "https://github.com/ComPWA/sphinx-pybtex-etal-style/blob/main/README.md",
"Source": "https://github.com/ComPWA/sphinx-pybtex-etal-style",
"Tracker": "https://github.com/ComPWA/sphinx-pybtex-etal-style/issues"
},
"split_keywords": [
"bibliography",
"bibtex",
"sphinx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2aeceeea4ddb4d5e5610f7c991506a8e61db717a6d8cd38b86c040fc703d5aca",
"md5": "b356e72373cabc1f0a5ac5d9e76fdb3b",
"sha256": "a3d4bce1334ed85f54a303726fa3031e1083cf7760f1dd89a1ac598a7557d87f"
},
"downloads": -1,
"filename": "sphinx_pybtex_etal_style-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b356e72373cabc1f0a5ac5d9e76fdb3b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5761,
"upload_time": "2023-12-07T18:11:35",
"upload_time_iso_8601": "2023-12-07T18:11:35.396887Z",
"url": "https://files.pythonhosted.org/packages/2a/ec/eeea4ddb4d5e5610f7c991506a8e61db717a6d8cd38b86c040fc703d5aca/sphinx_pybtex_etal_style-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f47ecd4ed20410244e978ae28ec33f9085000224dbf336c3530a00afc46c05cb",
"md5": "d2c11ffb4196473c4016b21b3e6cd95c",
"sha256": "e77f540b6a63b61ec76e284e6a6f68a10e678c9f7dbb9d2d0e7732271744b236"
},
"downloads": -1,
"filename": "sphinx-pybtex-etal-style-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "d2c11ffb4196473c4016b21b3e6cd95c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 11393,
"upload_time": "2023-12-07T18:11:37",
"upload_time_iso_8601": "2023-12-07T18:11:37.132062Z",
"url": "https://files.pythonhosted.org/packages/f4/7e/cd4ed20410244e978ae28ec33f9085000224dbf336c3530a00afc46c05cb/sphinx-pybtex-etal-style-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-07 18:11:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ComPWA",
"github_project": "sphinx-pybtex-etal-style",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-pybtex-etal-style"
}
JSON
