.. _moduleDocumentationWriters:

music21.documentation.writers
=============================

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

.. automodule:: music21.documentation.writers

CorpusReferenceReSTWriter
-------------------------

.. autoclass:: music21.documentation.writers.CorpusReferenceReSTWriter

.. rubric:: :class:`~music21.documentation.writers.CorpusReferenceReSTWriter` bases

- :class:`~music21.documentation.writers.ReSTWriter`
- :class:`~music21.documentation.writers.DocumentationWriter`

.. rubric:: :class:`~music21.documentation.writers.CorpusReferenceReSTWriter` methods

.. automethod:: music21.documentation.writers.CorpusReferenceReSTWriter.run

Methods inherited from :class:`~music21.documentation.writers.ReSTWriter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.writers.ReSTWriter.write`

Methods inherited from :class:`~music21.documentation.writers.DocumentationWriter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.writers.DocumentationWriter.setupOutputDirectory`
   - :meth:`~music21.documentation.writers.DocumentationWriter.sourceToAutogenerated`

DocumentationWriter
-------------------

.. autoclass:: music21.documentation.writers.DocumentationWriter

.. rubric:: :class:`~music21.documentation.writers.DocumentationWriter` methods

.. automethod:: music21.documentation.writers.DocumentationWriter.run

.. automethod:: music21.documentation.writers.DocumentationWriter.setupOutputDirectory

.. automethod:: music21.documentation.writers.DocumentationWriter.sourceToAutogenerated

IPythonNotebookReSTWriter
-------------------------

.. autoclass:: music21.documentation.writers.IPythonNotebookReSTWriter

.. rubric:: :class:`~music21.documentation.writers.IPythonNotebookReSTWriter` bases

- :class:`~music21.documentation.writers.ReSTWriter`
- :class:`~music21.documentation.writers.DocumentationWriter`

.. rubric:: :class:`~music21.documentation.writers.IPythonNotebookReSTWriter` read-only properties

.. autoattribute:: music21.documentation.writers.IPythonNotebookReSTWriter.rstEditingWarningFormat

.. rubric:: :class:`~music21.documentation.writers.IPythonNotebookReSTWriter` methods

.. automethod:: music21.documentation.writers.IPythonNotebookReSTWriter.blankLineAfterLiteral

.. automethod:: music21.documentation.writers.IPythonNotebookReSTWriter.cleanConvertedNotebook

.. automethod:: music21.documentation.writers.IPythonNotebookReSTWriter.cleanupNotebookAssets

.. automethod:: music21.documentation.writers.IPythonNotebookReSTWriter.convertOneNotebook

.. automethod:: music21.documentation.writers.IPythonNotebookReSTWriter.iterateSequencePairwise

.. automethod:: music21.documentation.writers.IPythonNotebookReSTWriter.notebookFilePathToRstFilePath

.. automethod:: music21.documentation.writers.IPythonNotebookReSTWriter.run

.. automethod:: music21.documentation.writers.IPythonNotebookReSTWriter.runNBConvert

.. automethod:: music21.documentation.writers.IPythonNotebookReSTWriter.writeIndexRst

Methods inherited from :class:`~music21.documentation.writers.ReSTWriter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.writers.ReSTWriter.write`

Methods inherited from :class:`~music21.documentation.writers.DocumentationWriter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.writers.DocumentationWriter.setupOutputDirectory`
   - :meth:`~music21.documentation.writers.DocumentationWriter.sourceToAutogenerated`

ModuleReferenceReSTWriter
-------------------------

.. autoclass:: music21.documentation.writers.ModuleReferenceReSTWriter

.. rubric:: :class:`~music21.documentation.writers.ModuleReferenceReSTWriter` bases

- :class:`~music21.documentation.writers.ReSTWriter`
- :class:`~music21.documentation.writers.DocumentationWriter`

.. rubric:: :class:`~music21.documentation.writers.ModuleReferenceReSTWriter` methods

.. automethod:: music21.documentation.writers.ModuleReferenceReSTWriter.run

.. automethod:: music21.documentation.writers.ModuleReferenceReSTWriter.writeIndexRst

Methods inherited from :class:`~music21.documentation.writers.ReSTWriter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.writers.ReSTWriter.write`

Methods inherited from :class:`~music21.documentation.writers.DocumentationWriter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.writers.DocumentationWriter.setupOutputDirectory`
   - :meth:`~music21.documentation.writers.DocumentationWriter.sourceToAutogenerated`

ReSTWriter
----------

.. autoclass:: music21.documentation.writers.ReSTWriter

.. rubric:: :class:`~music21.documentation.writers.ReSTWriter` bases

- :class:`~music21.documentation.writers.DocumentationWriter`

.. rubric:: :class:`~music21.documentation.writers.ReSTWriter` methods

.. automethod:: music21.documentation.writers.ReSTWriter.run

.. automethod:: music21.documentation.writers.ReSTWriter.write

Methods inherited from :class:`~music21.documentation.writers.DocumentationWriter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.writers.DocumentationWriter.setupOutputDirectory`
   - :meth:`~music21.documentation.writers.DocumentationWriter.sourceToAutogenerated`

StaticFileCopier
----------------

.. autoclass:: music21.documentation.writers.StaticFileCopier

.. rubric:: :class:`~music21.documentation.writers.StaticFileCopier` bases

- :class:`~music21.documentation.writers.DocumentationWriter`

.. rubric:: :class:`~music21.documentation.writers.StaticFileCopier` methods

.. automethod:: music21.documentation.writers.StaticFileCopier.run

Methods inherited from :class:`~music21.documentation.writers.DocumentationWriter`:

.. hlist::
   :columns: 3

   - :meth:`~music21.documentation.writers.DocumentationWriter.setupOutputDirectory`
   - :meth:`~music21.documentation.writers.DocumentationWriter.sourceToAutogenerated`
