CitationType

class documenteer.citations.CitationType(*values)

Bases: StrEnum

The kind of work a citation describes.

This is the citation’s counterpart to DataCite’s resourceTypeGeneral: it says what the cited thing is, which is what decides the schema.org type a landing page publishes it under (see SCHEMA_ORG_TYPES). A work whose type is unstated is not forced into one — an untyped citation keeps the generic default — so the vocabulary can stay small and every member can mean something definite.

Attributes Summary

article	A paper published in a journal or conference proceedings.
dataset	A data release, catalog, or other published dataset.
other	A work that none of the other types describes.
report	A technical report, including a Rubin technote.
software	A software package or codebase.

Attributes Documentation

article = 'article'

A paper published in a journal or conference proceedings.

dataset = 'dataset'

A data release, catalog, or other published dataset.

This is the type Google Dataset Search indexes, so it is the one worth setting on every data product a site publishes.

other = 'other'

A work that none of the other types describes.

Setting it says the type was considered, where leaving the type unset says nothing at all; both publish the same generic schema.org type.

report = 'report'

A technical report, including a Rubin technote.

software = 'software'

A software package or codebase.