Sphinx docx builder extension
Project description
Docxbuilder is a Sphinx extension to build docx formatted documents.
Requirements
- Python:
2.7, 3.5 or latter
- Sphinx:
1.7.6 or later
Install
Use pip:
pip install docxbuilder
Usage
Add ‘docxbuilder’ to extensions configuration of conf.py:
extensions = ['docxbuilder']
and build your documents:
make docx
Configuration
variable |
meaning |
default |
---|---|---|
docx_documents |
This determines how to group the document tree by a list of tuples, like latex_documents. The tuple is root document file, generated docx file name, document properties, and toctree_only flag. |
The root file, docx name, and properties are generated based on other configurations. toctree_only is False. |
docx_style |
A path to a style file. If this value is an empty string, default style file is used. |
''. Use default style. |
docx_coverpage |
If this value is true, the coverpage of the style file is inserted to generated documents. |
True |
docx_pagebreak_before_section |
Specify a section level. Before each sections which level is larger than or equal to this option value, a page break is inserted. |
0. No page break is inserted. |
docx_pagebreak_after_table_of_contents |
Specify a section level. After each table of contents which appears in section level larger than or equal to this option value, a page break is inserted. |
0. Page break is inserted only before first section. |
docx_table_options |
Table arrangement option. Specify a dictionary with bellow keys.
|
|
The below code is a configuration example:
docx_documents = [
('index', 'docxbuilder.docx', {
'title': project,
'creator': author,
'subject': 'A manual of docxbuilder',
}, True),
]
docx_style = 'path/to/custom_style.docx'
docx_pagebreak_before_section = 1
docx_pagebreak_after_table_of_contents = 0
docx_table_options = {
'landscape_columns': 6,
'in_single_page': False,
'row_splittable': True,
'header_in_all_page': False,
}
Style file
Generated docx file’s design is customized by a style file (The default style is docxbuilder/docx/style.docx). The style file is a docx file, which defines some paragraph, character, and table styles.
The below lists shows typical styles.
Character styles:
Emphasis
Strong
Literal
Hyperlink
Footnote Reference
Paragraph styles:
Body Text
Footnote Text
Definition Term
Literal Block
Image Caption, Table Caution, Literal Caption
Heading 1, Heading 2, …, Heading N
TOC Heading
toc 1, toc 2, …, toc N
List Bullet
List Number
Table styles:
Table
Field List
Admonition Note
TODO
Support math role and directive.
Support tabular_col_spec directive.
Support URL path for images.
Licence
MIT Licence
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for docxbuilder-1.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 529cfcac2d60a20c44906daa910c1f70cbe053979faefbbae26a88ae150fa53f |
|
MD5 | e1f2bdaa28b59996ac3f01eb6b342204 |
|
BLAKE2b-256 | 7a90a944c3452be8e5bc2b69dab7b7cb1d157348280bb332012632329cb3e5fa |