Skip to main content

Sphinx docx builder extension

Project description

Documentation Status

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docxbuilder-1.2.0.tar.gz (68.5 kB view details)

Uploaded Source

Built Distribution

docxbuilder-1.2.0-py2.py3-none-any.whl (73.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file docxbuilder-1.2.0.tar.gz.

File metadata

  • Download URL: docxbuilder-1.2.0.tar.gz
  • Upload date:
  • Size: 68.5 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for docxbuilder-1.2.0.tar.gz
Algorithm Hash digest
SHA256 06a1cc585f06f1ff6810000acf4f23c7f52c504cd3b980f92ce4343882ce2b0d
MD5 6f0cff79837a1fc3cdf2b1709bb69df0
BLAKE2b-256 c41bdee7dc480072c52492551e90da5196c0a5cd2632d4c66f0196b179760404

See more details on using hashes here.

File details

Details for the file docxbuilder-1.2.0-py2.py3-none-any.whl.

File metadata

  • Download URL: docxbuilder-1.2.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 73.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using 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

File hashes

Hashes for docxbuilder-1.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a458e050d5f5689c17eba4c2680e551b1a22d00380a81ce72b15a5bde439c4bd
MD5 0eccad101c0938fae54b7e9502a45534
BLAKE2b-256 4c329fe10ca86bf0eb4c2bb494ba9dc1b3bfdda6bbb6da5b309d7db8ae73d02a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page