docxbuilder

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. landscape_columns Tables with the number of columns equal to or larger than this option value, are arranged on landscape pages. in_single_page If this value is true, each table is arranged in single page as possible. row_splittable If this value is false, each table row shall not be arranged across multiple pages. header_in_all_page If this value is true and a table is arranged across multiple pages, the header is displayed in the each pages.	landscape_columns: 0 in_single_page: False row_splittable: True header_in_all_page: False

The below code is a configuration example:

docx_documents = [
    (master_doc, '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

Release files for docxbuilder 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for docxbuilder 1.0.0
File	Size	Uploaded
docxbuilder-1.0.0.tar.gz	62.6 kB	Mar 24, 2019	Details

Built distribution (wheel)

Table of built distributions (wheels) for docxbuilder 1.0.0
File	Interpreter	ABI	Platform	Reset
docxbuilder-1.0.0-py3-none-any.whl 38.0 kB Mar 24, 2019	Python 3	none	any	Details

Total release size:100.6 kB

Release files / docxbuilder-1.0.0.tar.gz

Download URL	docxbuilder-1.0.0.tar.gz
Size	62.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`bb11750ee012c37cf407d6b06a54b5a0457380f440b9f556a0c0f47468f4dd0b`
BLAKE2b-256 checksum How to use checksums	`a237c81e525876e18dadff0d35dd4b6d9fcc9da873bea6fe3da35445a9647798`
Upload date	Mar 24, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.13.0 pkginfo/1.5.0.1 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2`

Release files / docxbuilder-1.0.0-py3-none-any.whl

Download URL	docxbuilder-1.0.0-py3-none-any.whl
Size	38.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`06d966639f9ba5ec7cc4c878fcb5bbb7be300869ab4ac9d803104b013cbc6b0f`
BLAKE2b-256 checksum How to use checksums	`1c523562c646c1cbea177dc882ce8cbe0b13a738a170e8d116a30e9c718eb816`
Upload date	Mar 24, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.13.0 pkginfo/1.5.0.1 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2`