.. -*- coding: utf-8 -*-
   Copyright © 2019-2025, Broadcom, Inc.  All rights reserved.
   SPDX-License-Identifier: BSD-2-Clause

.. _api:

Public Methods
==============

The primary public method is the ``load`` method which loads the
attribute definitions from YAML file located in the directory tree.
Other methods are exported, and are documented here, but it is expected
that these methods are only used by the management commands.

.. currentmodule:: django_yamlconf

.. _api-add_attributes:

``add_attributes`` Function
---------------------------

.. autofunction:: add_attributes

.. _api-defined_attributes:

``defined_attributes`` Function
-------------------------------

.. autofunction:: defined_attributes

.. _api-explain:

``explain`` Function
--------------------

.. autofunction:: explain

.. _api-list_attrs:

``list_attrs`` Function
-----------------------

.. autofunction:: list_attrs

.. _api-load:

``load`` Function
-----------------

.. autofunction:: load

.. _api-sysfiles:

``sysfiles`` Function
---------------------

.. autofunction:: sysfiles