diff options
| author | Michael Williamson <mike@zwobble.org> | 2015-09-12 17:33:31 +0100 |
|---|---|---|
| committer | Michael Williamson <mike@zwobble.org> | 2015-09-12 17:33:31 +0100 |
| commit | aeb69f46af4f59bca08c38117c41ce1d5dc82e06 (patch) | |
| tree | 76bd515246c8b1ccb98cd07b70c4ce09d896fa51 /README.md | |
| parent | 7c4193e8325fa914d92287dd4dfdb8fc004cd5c6 (diff) | |
Add docs for embed_style_map
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
@@ -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: |
