From aeb69f46af4f59bca08c38117c41ce1d5dc82e06 Mon Sep 17 00:00:00 2001 From: Michael Williamson Date: Sat, 12 Sep 2015 17:33:31 +0100 Subject: Add docs for embed_style_map --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index db17063..f782f23 100644 --- a/README.md +++ b/README.md @@ -255,6 +255,19 @@ Each paragraph is followed by two newlines. * `messages`: any messages, such as errors and warnings +#### `mammoth.embed_style_map(fileobj, style_map)` + +Embeds the style map `style_map` into `fileobj`. +When Mammoth reads a file object, +it will use the embedded style if no explicit style map is provided. + +* `fileobj`: a file-like object containing the source document. + Files should be opened in binary mode. + +* `style_map`: the style map to embed. + +* Returns `None`. + #### Messages Each message has the following properties: -- cgit v1.2.3