diff --git a/docs/internals.rst b/docs/internals.rst index 80fc8661..4ff8c91c 100644 --- a/docs/internals.rst +++ b/docs/internals.rst @@ -40,7 +40,8 @@ method, that is returning an HTML content and some metadata. Take a look to the Markdown reader:: - class MarkdownReader(object): + class MarkdownReader(Reader): + enabled = bool(Markdown) def read(self, filename): """Parse content and metadata of markdown files""" @@ -59,6 +60,12 @@ Take a look to the Markdown reader:: Simple isn't it ? +If your new reader requires additional Python dependencies then you should wrap +their `imports` statements in `try...except`. Then inside the reader's class +set the `enabled` class attribute to mark import success or failure. This makes +it possible for users to continue using their favourite markup method without +needing to install modules for all the additional formats they don't use. + How to implement a new generator ? ==================================