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 | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinxpapyrus-docxbuilder-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b58a0751252e31132b396ac9a722643404c88c54187ca61eaac63d9922a0eb2f |
|
MD5 | 10e9ca08a29e91f4106ae326635fb2d5 |
|
BLAKE2b-256 | d5f31ebbc2e1a0744314db0825649d1662951776e2c7fff8f95d23bd69ced1e6 |
Hashes for sphinxpapyrus_docxbuilder-0.1.1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 063ad4d768b1c0c5ac9f745d3f640fb5ace2c48a7e7f16f81a1476f1bf23985f |
|
MD5 | a9b2a2d22e6ffac310750a9ce1541c1f |
|
BLAKE2b-256 | 69b9a4404715973f6b80666ca82b44ac449fc19eea9e9c8f75d61f9ed302aedc |