Skip to main content

Sphinx docx builder extension

Project description

Documentation Status

Docxbuilder is a Sphinx extension to build docx formatted documents.

Note

This extension is developed based on sphinx-docxbuilder. Though, there is no compatibility between these extensions.

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.

Files for docxbuilder, version 1.1.5
Filename, size File type Python version Upload date Hashes
Filename, size docxbuilder-1.1.5-py2.py3-none-any.whl (72.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size docxbuilder-1.1.5.tar.gz (67.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page