.. _moduleDocumentationDocumenters:

music21.documentation.documenters
=================================

.. WARNING: DO NOT EDIT THIS FILE:
   AUTOMATICALLY GENERATED.
   PLEASE EDIT THE .py FILE DIRECTLY.

.. automodule:: music21.documentation.documenters

AttributeDocumenter
-------------------

.. autoclass:: music21.documentation.documenters.AttributeDocumenter

.. rubric:: :class:`~music21.documentation.documenters.AttributeDocumenter` bases

- :class:`~music21.documentation.documenters.MemberDocumenter`
- :class:`~music21.documentation.documenters.ObjectDocumenter`
- :class:`~music21.documentation.documenters.Documenter`

.. rubric:: :class:`~music21.documentation.documenters.AttributeDocumenter` read-only properties

.. autoattribute:: music21.documentation.documenters.AttributeDocumenter.rstAutodocDirectiveFormat

.. autoattribute:: music21.documentation.documenters.AttributeDocumenter.sphinxCrossReferenceRole

Read-only properties inherited from :class:`~music21.documentation.documenters.MemberDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.MemberDocumenter.referentPackagesystemPath`

Read-only properties inherited from :class:`~music21.documentation.documenters.ObjectDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.ObjectDocumenter.rstCrossReferenceString`

Read-only properties inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.Documenter.rstEditingWarningFormat`

.. rubric:: :class:`~music21.documentation.documenters.AttributeDocumenter` methods

Methods inherited from :class:`~music21.documentation.documenters.MemberDocumenter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.documenters.MemberDocumenter.run`

Methods inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.documenters.Documenter.makeHeading`
   - :meth:`~music21.documentation.documenters.Documenter.makeRubric`

.. rubric:: :class:`~music21.documentation.documenters.AttributeDocumenter` instance variables

Instance variables inherited from :class:`~music21.documentation.documenters.MemberDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.MemberDocumenter.definingClass`
   - :attr:`~music21.documentation.documenters.MemberDocumenter.memberName`
   - :attr:`~music21.documentation.documenters.MemberDocumenter.referent`

Instance variables inherited from :class:`~music21.documentation.documenters.ObjectDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.ObjectDocumenter.referent`

ClassDocumenter
---------------

.. autoclass:: music21.documentation.documenters.ClassDocumenter

.. rubric:: :class:`~music21.documentation.documenters.ClassDocumenter` bases

- :class:`~music21.documentation.documenters.ObjectDocumenter`
- :class:`~music21.documentation.documenters.Documenter`

.. rubric:: :class:`~music21.documentation.documenters.ClassDocumenter` read-only properties

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.baseClassDocumenters

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.baseClasses

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.docAttr

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.docOrder

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.inheritedDocAttrMapping

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.inheritedMethodsMapping

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.inheritedReadonlyPropertiesMapping

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.inheritedReadwritePropertiesMapping

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.methods

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.readonlyProperties

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.readwriteProperties

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.referentPackagesystemPath

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.rstAutodocDirectiveFormat

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.rstBasesFormat

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.rstDocAttrFormat

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.rstInheritedDocAttrFormat

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.rstInheritedMethodsFormat

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.rstInheritedReadonlyPropertiesFormat

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.rstInheritedReadwritePropertiesFormat

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.rstMethodsFormat

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.rstReadonlyPropertiesFormat

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.rstReadwritePropertiesFormat

.. autoattribute:: music21.documentation.documenters.ClassDocumenter.sphinxCrossReferenceRole

Read-only properties inherited from :class:`~music21.documentation.documenters.ObjectDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.ObjectDocumenter.rstCrossReferenceString`

Read-only properties inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.Documenter.rstEditingWarningFormat`

.. rubric:: :class:`~music21.documentation.documenters.ClassDocumenter` methods

.. automethod:: music21.documentation.documenters.ClassDocumenter.findAttributes

.. automethod:: music21.documentation.documenters.ClassDocumenter.findOneAttribute

.. automethod:: music21.documentation.documenters.ClassDocumenter.fromIdentityMap

.. automethod:: music21.documentation.documenters.ClassDocumenter.run

.. automethod:: music21.documentation.documenters.ClassDocumenter.sortMemberLists

Methods inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.documenters.Documenter.makeHeading`
   - :meth:`~music21.documentation.documenters.Documenter.makeRubric`

.. rubric:: :class:`~music21.documentation.documenters.ClassDocumenter` instance variables

Instance variables inherited from :class:`~music21.documentation.documenters.ObjectDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.ObjectDocumenter.referent`

CorpusDocumenter
----------------

.. autoclass:: music21.documentation.documenters.CorpusDocumenter

.. rubric:: :class:`~music21.documentation.documenters.CorpusDocumenter` bases

- :class:`~music21.documentation.documenters.Documenter`

.. rubric:: :class:`~music21.documentation.documenters.CorpusDocumenter` read-only properties

.. autoattribute:: music21.documentation.documenters.CorpusDocumenter.headingText

.. autoattribute:: music21.documentation.documenters.CorpusDocumenter.rstCorpusIntroductionFormat

.. autoattribute:: music21.documentation.documenters.CorpusDocumenter.rstPageReferenceFormat

Read-only properties inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.Documenter.rstEditingWarningFormat`

.. rubric:: :class:`~music21.documentation.documenters.CorpusDocumenter` methods

.. automethod:: music21.documentation.documenters.CorpusDocumenter.getRstComposerDictFormat

.. automethod:: music21.documentation.documenters.CorpusDocumenter.getRstComposerIntroductionFormat

.. automethod:: music21.documentation.documenters.CorpusDocumenter.getRstComposerWorksFormat

.. automethod:: music21.documentation.documenters.CorpusDocumenter.getRstVirtualWorkFileDictFormat

.. automethod:: music21.documentation.documenters.CorpusDocumenter.getRstWorkFileDictFormat

.. automethod:: music21.documentation.documenters.CorpusDocumenter.run

Methods inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.documenters.Documenter.makeHeading`
   - :meth:`~music21.documentation.documenters.Documenter.makeRubric`

Documenter
----------

.. autoclass:: music21.documentation.documenters.Documenter

.. rubric:: :class:`~music21.documentation.documenters.Documenter` read-only properties

.. autoattribute:: music21.documentation.documenters.Documenter.rstEditingWarningFormat

.. rubric:: :class:`~music21.documentation.documenters.Documenter` methods

.. automethod:: music21.documentation.documenters.Documenter.makeHeading

.. automethod:: music21.documentation.documenters.Documenter.makeRubric

.. automethod:: music21.documentation.documenters.Documenter.run

FunctionDocumenter
------------------

.. autoclass:: music21.documentation.documenters.FunctionDocumenter

.. rubric:: :class:`~music21.documentation.documenters.FunctionDocumenter` bases

- :class:`~music21.documentation.documenters.ObjectDocumenter`
- :class:`~music21.documentation.documenters.Documenter`

.. rubric:: :class:`~music21.documentation.documenters.FunctionDocumenter` read-only properties

.. autoattribute:: music21.documentation.documenters.FunctionDocumenter.referentPackagesystemPath

.. autoattribute:: music21.documentation.documenters.FunctionDocumenter.rstAutodocDirectiveFormat

.. autoattribute:: music21.documentation.documenters.FunctionDocumenter.sphinxCrossReferenceRole

Read-only properties inherited from :class:`~music21.documentation.documenters.ObjectDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.ObjectDocumenter.rstCrossReferenceString`

Read-only properties inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.Documenter.rstEditingWarningFormat`

.. rubric:: :class:`~music21.documentation.documenters.FunctionDocumenter` methods

.. automethod:: music21.documentation.documenters.FunctionDocumenter.run

Methods inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.documenters.Documenter.makeHeading`
   - :meth:`~music21.documentation.documenters.Documenter.makeRubric`

.. rubric:: :class:`~music21.documentation.documenters.FunctionDocumenter` instance variables

Instance variables inherited from :class:`~music21.documentation.documenters.ObjectDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.ObjectDocumenter.referent`

MemberDocumenter
----------------

.. autoclass:: music21.documentation.documenters.MemberDocumenter

.. rubric:: :class:`~music21.documentation.documenters.MemberDocumenter` bases

- :class:`~music21.documentation.documenters.ObjectDocumenter`
- :class:`~music21.documentation.documenters.Documenter`

.. rubric:: :class:`~music21.documentation.documenters.MemberDocumenter` read-only properties

.. autoattribute:: music21.documentation.documenters.MemberDocumenter.referentPackagesystemPath

Read-only properties inherited from :class:`~music21.documentation.documenters.ObjectDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.ObjectDocumenter.rstCrossReferenceString`

Read-only properties inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.Documenter.rstEditingWarningFormat`

.. rubric:: :class:`~music21.documentation.documenters.MemberDocumenter` methods

.. automethod:: music21.documentation.documenters.MemberDocumenter.rstAutodocDirectiveFormat

.. automethod:: music21.documentation.documenters.MemberDocumenter.run

.. automethod:: music21.documentation.documenters.MemberDocumenter.sphinxCrossReferenceRole

Methods inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.documenters.Documenter.makeHeading`
   - :meth:`~music21.documentation.documenters.Documenter.makeRubric`

.. rubric:: :class:`~music21.documentation.documenters.MemberDocumenter` instance variables

.. attribute:: MemberDocumenter.definingClass

	the class the referent belongs to, such as (no quotes)
	key.KeySignature

.. attribute:: MemberDocumenter.memberName

	the short name of the member, for instance "mode"

.. attribute:: MemberDocumenter.referent

	the attribute or method itself, such as (no quotes)
	key.KeySignature.mode

Instance variables inherited from :class:`~music21.documentation.documenters.ObjectDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.ObjectDocumenter.referent`

MethodDocumenter
----------------

.. autoclass:: music21.documentation.documenters.MethodDocumenter

.. rubric:: :class:`~music21.documentation.documenters.MethodDocumenter` bases

- :class:`~music21.documentation.documenters.MemberDocumenter`
- :class:`~music21.documentation.documenters.ObjectDocumenter`
- :class:`~music21.documentation.documenters.Documenter`

.. rubric:: :class:`~music21.documentation.documenters.MethodDocumenter` read-only properties

.. autoattribute:: music21.documentation.documenters.MethodDocumenter.rstAutodocDirectiveFormat

.. autoattribute:: music21.documentation.documenters.MethodDocumenter.sphinxCrossReferenceRole

Read-only properties inherited from :class:`~music21.documentation.documenters.MemberDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.MemberDocumenter.referentPackagesystemPath`

Read-only properties inherited from :class:`~music21.documentation.documenters.ObjectDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.ObjectDocumenter.rstCrossReferenceString`

Read-only properties inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.Documenter.rstEditingWarningFormat`

.. rubric:: :class:`~music21.documentation.documenters.MethodDocumenter` methods

Methods inherited from :class:`~music21.documentation.documenters.MemberDocumenter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.documenters.MemberDocumenter.run`

Methods inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.documenters.Documenter.makeHeading`
   - :meth:`~music21.documentation.documenters.Documenter.makeRubric`

.. rubric:: :class:`~music21.documentation.documenters.MethodDocumenter` instance variables

Instance variables inherited from :class:`~music21.documentation.documenters.MemberDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.MemberDocumenter.definingClass`
   - :attr:`~music21.documentation.documenters.MemberDocumenter.memberName`
   - :attr:`~music21.documentation.documenters.MemberDocumenter.referent`

Instance variables inherited from :class:`~music21.documentation.documenters.ObjectDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.ObjectDocumenter.referent`

ModuleDocumenter
----------------

.. autoclass:: music21.documentation.documenters.ModuleDocumenter

.. rubric:: :class:`~music21.documentation.documenters.ModuleDocumenter` bases

- :class:`~music21.documentation.documenters.ObjectDocumenter`
- :class:`~music21.documentation.documenters.Documenter`

.. rubric:: :class:`~music21.documentation.documenters.ModuleDocumenter` read-only properties

.. autoattribute:: music21.documentation.documenters.ModuleDocumenter.classDocumenters

.. autoattribute:: music21.documentation.documenters.ModuleDocumenter.functionDocumenters

.. autoattribute:: music21.documentation.documenters.ModuleDocumenter.memberOrder

.. autoattribute:: music21.documentation.documenters.ModuleDocumenter.namesMapping

.. autoattribute:: music21.documentation.documenters.ModuleDocumenter.referenceName

.. autoattribute:: music21.documentation.documenters.ModuleDocumenter.referentPackagesystemPath

.. autoattribute:: music21.documentation.documenters.ModuleDocumenter.rstAutodocDirectiveFormat

.. autoattribute:: music21.documentation.documenters.ModuleDocumenter.rstPageReferenceFormat

.. autoattribute:: music21.documentation.documenters.ModuleDocumenter.sphinxCrossReferenceRole

Read-only properties inherited from :class:`~music21.documentation.documenters.ObjectDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.ObjectDocumenter.rstCrossReferenceString`

Read-only properties inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.Documenter.rstEditingWarningFormat`

.. rubric:: :class:`~music21.documentation.documenters.ModuleDocumenter` methods

.. automethod:: music21.documentation.documenters.ModuleDocumenter.run

Methods inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.documenters.Documenter.makeHeading`
   - :meth:`~music21.documentation.documenters.Documenter.makeRubric`

.. rubric:: :class:`~music21.documentation.documenters.ModuleDocumenter` instance variables

Instance variables inherited from :class:`~music21.documentation.documenters.ObjectDocumenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.ObjectDocumenter.referent`

ObjectDocumenter
----------------

.. autoclass:: music21.documentation.documenters.ObjectDocumenter

.. rubric:: :class:`~music21.documentation.documenters.ObjectDocumenter` bases

- :class:`~music21.documentation.documenters.Documenter`

.. rubric:: :class:`~music21.documentation.documenters.ObjectDocumenter` read-only properties

.. autoattribute:: music21.documentation.documenters.ObjectDocumenter.rstCrossReferenceString

Read-only properties inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :attr:`~music21.documentation.documenters.Documenter.rstEditingWarningFormat`

.. rubric:: :class:`~music21.documentation.documenters.ObjectDocumenter` methods

.. automethod:: music21.documentation.documenters.ObjectDocumenter.referentPackagesystemPath

.. automethod:: music21.documentation.documenters.ObjectDocumenter.rstAutodocDirectiveFormat

.. automethod:: music21.documentation.documenters.ObjectDocumenter.sphinxCrossReferenceRole

Methods inherited from :class:`~music21.documentation.documenters.Documenter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.documenters.Documenter.makeHeading`
   - :meth:`~music21.documentation.documenters.Documenter.makeRubric`
   - :meth:`~music21.documentation.documenters.Documenter.run`

.. rubric:: :class:`~music21.documentation.documenters.ObjectDocumenter` instance variables

.. attribute:: ObjectDocumenter.referent

	the object being documented
