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

You can control the generated document by adding configurations into conf.py:

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

For more details, see the documentation.

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

Metadata

Release files for docxbuilder 1.1.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.1.0
File	Size	Uploaded
docxbuilder-1.1.0.tar.gz	66.3 kB	Aug 6, 2019	Details

Built distribution (wheel)

Table of built distributions (wheels) for docxbuilder 1.1.0
File	Interpreter	ABI	Platform	Reset
docxbuilder-1.1.0-py2.py3-none-any.whl 71.2 kB Aug 6, 2019	Python 3, Python 2	none	any	Details

Total release size: 137.5 kB

Release files / docxbuilder-1.1.0.tar.gz

Download URL	docxbuilder-1.1.0.tar.gz
Size	66.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`d93ac70af8500d978bbb5cdc9bbc8ca804c58861862e17af5ef0dd249fb11d8e`
BLAKE2b-256 checksum How to use checksums	`e53334bfbd98a75c3707208332c81cc378b1b0b071c2acc9def47296756f069f`
Upload date	Aug 6, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3`

Release files / docxbuilder-1.1.0-py2.py3-none-any.whl

Download URL	docxbuilder-1.1.0-py2.py3-none-any.whl
Size	71.2 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`b932da73a4085b5981f5fb701af7704ab92cb1ab53f49da37ca9285f0578e99e`
BLAKE2b-256 checksum How to use checksums	`60b8ce38534528b2f260da8f485e2b542278e7762e506aa28fee39717bbbaf85`
Upload date	Aug 6, 2019
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3`