fqr.docs.obj module

Docs objects.

class Pattern

Bases: object

Compiled regex patterns.

ModulePattern = re.compile('^(\\.\\. automodule:: )')

Matches automodule:: directive text to be stripped from rst files.

MinOneWordPattern = re.compile('\\w+')

Matches at least one valid word.

PathPattern = re.compile('(\\/|\\\\)')

Matches Windows and Unix paths.

PrefixPattern = re.compile('^(\\.)?(\\/|\\\\)?((src)(\\/|\\\\))?')

Matches packages that use the /src prefix.