{ "info": { "author": "Takayuki SHIMIZUKAWA", "author_email": "shimizukawa at gmail dot com", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Intended Audience :: System Administrators", "License :: OSI Approved :: MIT License", "Programming Language :: Python", "Topic :: Office/Business :: Office Suites", "Topic :: Software Development :: Documentation", "Topic :: Text Processing :: Markup" ], "description": "Sphinx docx builder extension generate single docx file from Sphinx document\r\nsource. This extension use python-docx module (included) for the docx file\r\ngeneration.\r\n\r\nFeatures\r\n========\r\n\r\n* This extension work on Multi-platform (not need OpenOffice or MS Word).\r\n* Usable sphinx syntax and directives:\r\n * heading line output\r\n * paragraph output (standard body text)\r\n * image and figure directive output\r\n * bullet-list and numbered-list output\r\n * table output (restrictive)\r\n\r\nCurrently, many directives and indented block are not work correctly, yet.\r\n\r\nSetup\r\n=====\r\n\r\nMake environment by easy_install\r\n---------------------------------\r\n\r\nNot yet.\r\n\r\nMake environment by buildout\r\n-----------------------------\r\n\r\n'hg clone' or download sphinxcontrib-docxbuilder archive from 'get source'\r\nmenu at http://bitbucket.org/shimizukawa/sphinxcontrib-docxbuilder ::\r\n\r\n $ cd /path/to/sphinxcontrib-docxbuilder\r\n $ python bootstrap.py -d init\r\n $ bin/buildout\r\n\r\n\r\nrun example\r\n------------\r\n\r\nfor example sphinx-docx building, simply run below::\r\n\r\n $ bin/example\r\n ...\r\n Saved new file to: examples/example-0.1.docx\r\n\r\n\r\nUsage\r\n=====\r\n\r\nSet 'sphinxcontrib-docxbuilder' to 'extensions' line of target sphinx source\r\nconf.py::\r\n\r\n extensions = ['sphinxcontrib-docxbuilder']\r\n\r\nExecute sphinx-build with below option::\r\n\r\n $ bin/sphinx-build -b docx [input-dir] [output-dir]\r\n $ ls [output-dir]\r\n output.docx\r\n\r\n\r\nRequirements\r\n============\r\n\r\n* Python 2.6 or later (not support 3.x)\r\n* `python-docx `_\r\n (not released, but included), Thanks Mike MacCana.\r\n* setuptools or distriubte.\r\n\r\nHistory\r\n=======\r\n\r\n0.0.1 (unreleased)\r\n--------------------\r\n* Not released.\r\n\r\n\r\nTodos\r\n======\r\n\r\nFunctionals\r\n------------\r\n* table output\r\n* toctree generation (dispose toctree output? create by docx function?)\r\n* reset number for non-continuous numbered list\r\n* add page-break directive\r\n* implement many many directives\r\n * note\r\n * warning\r\n * code highlighting\r\n * and etc....\r\n* using dotx template\r\n* some emphasis (italic, bold)\r\n\r\nEnvironments\r\n-------------\r\n* docx builder need python-docx package, but not distributed at PyPI.\r\n* python-docx can't generate (italic) and (bold) mode tag.\r\n\r\nKnown Issues\r\n-------------\r\n* some indented block output are not working correctly yet.\r\n * block-quote\r\n * literal-block\r\n* figure directive's caption become normal paragraph (not bundled with image).\r\n* python-docx using template's media(image) folder for temporarily, then some\r\n independent document's media files are shared unexpectly.\r\n* image directive break docx format (maybe very large file are included)", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://bitbucket.org/shimizukawa/sphinxcontrib-docxbuilder", "keywords": "sphinx,extension,builder,docx,OpenXML", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sphinxcontrib-docxbuilder", "package_url": "https://pypi.org/project/sphinxcontrib-docxbuilder/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/sphinxcontrib-docxbuilder/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://bitbucket.org/shimizukawa/sphinxcontrib-docxbuilder" }, "release_url": "https://pypi.org/project/sphinxcontrib-docxbuilder/0.0.1alpha/", "requires_dist": null, "requires_python": null, "summary": "Sphinx docx builder extension.", "version": "0.0.1alpha" }, "last_serial": 659884, "releases": { "0.0.1alpha": [] }, "urls": [] }