Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A Sphinx extension for Word (.docx) file output

Project description

sphinxpapyrus-docxbuilder is a Sphinx extension for Word (.docx) file output.

Features

  • Docx file as style template
  • Inline Markup
  • Headings
  • Bullet / Enumerated Multilevel List
  • Definition List
  • Field List / Option List as 2 collumn table
  • Blocks
  • Simple Table / Grid Table (surpport sppaning, nesting)
  • Transitions
  • Image / Figure
  • Footnotes as normal paragraph

Requirements

  • Sphinx>=1.3
  • python-docx==0.8.6

Installation

Run the following command:

pip install sphinxpapyrus-docxbuilder

Usage

Add the extension module name into conf.py in your Sphinx document:

extentions = ['sphinxpapyrus.docxbuilder']

Optionally, you can set style file:

docx_style = 'mystyle.docx'

You can also set docx core properties:

docx_coreproperties = {
    'title': 'Jelly Island Murders',
    'author': 'Arashiyama Hotori',
}

For more properties, see python-docx ducument .

Other docx options:

# Grouping the document tree into Docx files. List of tuples
# (source start file, target name, {coreproperties}).
docx_documents = [
    (master_doc, project, {
        'title': 'Document Title',
        'author': 'Author',
    }),
]
docx_pagebreak_level = 2  # insert page break before each heading 1, 2 and title
docx_imagetable_align = 'center'  # 'left', 'center', or 'right'

Finaly, output docx with following command:

make docx

Project details


Release history Release notifications

This version

0.1.1

Download files

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

Files for sphinxpapyrus-docxbuilder, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size sphinxpapyrus_docxbuilder-0.1.1-py2-none-any.whl (55.0 kB) File type Wheel Python version py2 Upload date Hashes View hashes
Filename, size sphinxpapyrus-docxbuilder-0.1.1.tar.gz (56.2 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 SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page