Previous topic

music21.documentation.library.iterators

Next topic

music21.documentation.make

Table Of Contents

Table Of Contents

This Page

music21.documentation.library.writers

CorpusReferenceReSTWriter

class music21.documentation.library.writers.CorpusReferenceReSTWriter

Write the corpus reference ReST file.

CorpusReferenceReSTWriter bases

CorpusReferenceReSTWriter methods

CorpusReferenceReSTWriter.run()

Methods inherited from ReSTWriter:

IPythonNotebookReSTWriter

class music21.documentation.library.writers.IPythonNotebookReSTWriter

Converts IPython notebooks into ReST, and handles their associated image files.

This class wraps the 3rd-party nbconvert Python script.

IPythonNotebookReSTWriter bases

IPythonNotebookReSTWriter methods

IPythonNotebookReSTWriter.convertOneNotebook(ipythonNotebookFilePath)

converts one .ipynb file to .rst using nbconvert.

returns True if IPythonNotebook was converted. returns False if IPythonNotebook’s converted .rst file is newer than the .ipynb file.

sends AssertionError if ipythonNotebookFilePath does not exist.

IPythonNotebookReSTWriter.iterateSequencePairwise(sequence)
IPythonNotebookReSTWriter.run()
IPythonNotebookReSTWriter.runNBConvert(ipythonNotebookFilePath)

Methods inherited from ReSTWriter:

ModuleReferenceReSTWriter

class music21.documentation.library.writers.ModuleReferenceReSTWriter

Writes module reference ReST files, and their index ReST file.

ModuleReferenceReSTWriter bases

ModuleReferenceReSTWriter methods

ModuleReferenceReSTWriter.run()

Methods inherited from ReSTWriter:

ReSTWriter

class music21.documentation.library.writers.ReSTWriter

Abstract base class for ReST writers.

Call .run() on the object to make it work.

ReSTWriter methods

ReSTWriter.run()
ReSTWriter.write(filePath, rst)

Write lines to filePath, only overwriting an existing file if the content differs.