Previous topic

music21.test.multiprocessTest

Next topic

music21.test.testLint

Table Of Contents

Table Of Contents

This Page

music21.test.testDocumentation

Module to test all the code excerpts in the .rst files in the music21 documentation.

Functions

music21.test.testDocumentation.getDocumentationFiles(runOne=False)

returns a list of namedtuples for each module that should be run

>>> test.testDocumentation.getDocumentationFiles()
[ModTuple(module='index.rst', fullModulePath='...music21/documentation/source/index.rst', 
moduleNoExtension='index', isIPYNB=False),
...]
music21.test.testDocumentation.main(runOne=False)

ModTuple

class music21.test.testDocumentation.ModTuple

ModTuple(module, fullModulePath, moduleNoExtension, isIPYNB)

ModTuple read-only properties

ModTuple.fullModulePath

Alias for field number 1

ModTuple.isIPYNB

Alias for field number 3

ModTuple.module

Alias for field number 0

ModTuple.moduleNoExtension

Alias for field number 2