# `DocName`: The Canonical `creators__year__title` Document Name

```{py:currentmodule} my.files.DocName
```

```{eval-rst}
.. autoclass:: my.files.DocName.DocName
```

## Building a name

```{eval-rst}
.. automethod:: my.files.DocName.DocName.mint
.. automethod:: my.files.DocName.DocName.parse
.. automethod:: my.files.DocName.DocName.is_valid
```

## Using a name

```{eval-rst}
.. automethod:: my.files.DocName.DocName.filename
.. automethod:: my.files.DocName.DocName.disambiguated
```

## Slots

```{eval-rst}
.. autofunction:: my.files.DocName.creators_slot
.. autofunction:: my.files.DocName.person_slot
.. autofunction:: my.files.DocName.split_person
.. autofunction:: my.files.DocName.year_slot
.. autofunction:: my.files.DocName.title_slot
.. autofunction:: my.files.DocName.uid_slot
.. autofunction:: my.files.DocName.uid_handle
.. autofunction:: my.files.DocName.site_slot
```

## Cleaning

```{eval-rst}
.. autofunction:: my.files.DocName.clean_section
.. autofunction:: my.files.DocName.uid_clean
.. autofunction:: my.files.DocName.without_leading_article
```