sphinx-pybtex-etal-style


Namesphinx-pybtex-etal-style JSON
Version 0.0.3 PyPI version JSON
download
home_pageNone
SummaryAbbreviate long author lists with et al. in BibTeX bibliographies for Sphinx
upload_time2024-10-29 10:58:09
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseBSD 3-Clause License
keywords bibliography bibtex sphinx
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # `sphinx-pybtex-etal-style`

[![PyPI package](https://badge.fury.io/py/sphinx-pybtex-etal-style.svg)](https://pypi.org/project/sphinx-pybtex-etal-style)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/sphinx-pybtex-etal-style)](https://pypi.org/project/sphinx-pybtex-etal-style)
[![BSD 3-Clause license](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/sphinx-pybtex-etal-style)
[![CI status](https://github.com/ComPWA/sphinx-pybtex-etal-style/workflows/CI/badge.svg)](https://github.com/ComPWA/sphinx-pybtex-etal-style/actions?query=branch%3Amain+workflow%3ACI)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy.readthedocs.io)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/sphinx-pybtex-etal-style/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/sphinx-pybtex-etal-style/main)
[![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)

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": null,
    "name": "sphinx-pybtex-etal-style",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "compwa-admin@ep1.rub.de",
    "keywords": "bibliography, bibtex, sphinx",
    "author": null,
    "author_email": "Common Partial Wave Analysis <compwa-admin@ep1.rub.de>",
    "download_url": "https://files.pythonhosted.org/packages/05/cb/c75d1173988344a5fabd9dbeea742e4a8c452953e68f1c25d844733b62a6/sphinx_pybtex_etal_style-0.0.3.tar.gz",
    "platform": null,
    "description": "# `sphinx-pybtex-etal-style`\n\n[![PyPI package](https://badge.fury.io/py/sphinx-pybtex-etal-style.svg)](https://pypi.org/project/sphinx-pybtex-etal-style)\n[![Supported Python versions](https://img.shields.io/pypi/pyversions/sphinx-pybtex-etal-style)](https://pypi.org/project/sphinx-pybtex-etal-style)\n[![BSD 3-Clause license](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)\n[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/sphinx-pybtex-etal-style)\n[![CI status](https://github.com/ComPWA/sphinx-pybtex-etal-style/workflows/CI/badge.svg)](https://github.com/ComPWA/sphinx-pybtex-etal-style/actions?query=branch%3Amain+workflow%3ACI)\n[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy.readthedocs.io)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/sphinx-pybtex-etal-style/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/sphinx-pybtex-etal-style/main)\n[![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)\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.3",
    "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": "a34d8beb18b2cf347e152899a1a595f85049d691fbcd9a60e38756144742ca8f",
                "md5": "7c04c287fff486522ad1095f47a7ebec",
                "sha256": "51170abd9fcf5ba5d09ffb890c1b722448d8d185b9b9b5a2feb869c57256f2ff"
            },
            "downloads": -1,
            "filename": "sphinx_pybtex_etal_style-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7c04c287fff486522ad1095f47a7ebec",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 6032,
            "upload_time": "2024-10-29T10:58:07",
            "upload_time_iso_8601": "2024-10-29T10:58:07.973088Z",
            "url": "https://files.pythonhosted.org/packages/a3/4d/8beb18b2cf347e152899a1a595f85049d691fbcd9a60e38756144742ca8f/sphinx_pybtex_etal_style-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "05cbc75d1173988344a5fabd9dbeea742e4a8c452953e68f1c25d844733b62a6",
                "md5": "255301b79d2be772164ec47dc8282bec",
                "sha256": "e43beb55bc33f01d9b4d0ac90b20ad1d7209238d993d3256a973946aeeece262"
            },
            "downloads": -1,
            "filename": "sphinx_pybtex_etal_style-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "255301b79d2be772164ec47dc8282bec",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 11855,
            "upload_time": "2024-10-29T10:58:09",
            "upload_time_iso_8601": "2024-10-29T10:58:09.749555Z",
            "url": "https://files.pythonhosted.org/packages/05/cb/c75d1173988344a5fabd9dbeea742e4a8c452953e68f1c25d844733b62a6/sphinx_pybtex_etal_style-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-29 10:58:09",
    "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"
}
None
Elapsed time: 0.36334s