BibtexEntryType#

class documenteer.citations.BibtexEntryType(*values)#

Bases: StrEnum

The BibTeX entry type to compose a citation as.

The vocabulary is biblatex’s, which is the one Zenodo and GitHub’s “Cite this repository” export in. Classic BibTeX defined no entry type for a dataset or for software, and a classic style that meets one it does not know typesets it as @misc — which is what Documenteer emitted for every work before. So naming the specific type costs a reader of a classic style nothing and tells biblatex what the work actually is.

Attributes Summary

article

For a paper published in a journal or conference proceedings.

dataset

For a published dataset.

misc

For a work without a more specific type, such as a website.

software

For a software package or codebase.

techreport

For technical reports, including Rubin technotes.

Attributes Documentation

article = 'article'#

For a paper published in a journal or conference proceedings.

dataset = 'dataset'#

For a published dataset.

misc = 'misc'#

For a work without a more specific type, such as a website.

This is the entry type DataCite’s own BibTeX export uses, and the one a work whose type is unstated composes as.

software = 'software'#

For a software package or codebase.

techreport = 'techreport'#

For technical reports, including Rubin technotes.