{ "info": { "author": "Isao Hara", "author_email": "isao-hara@aist.go.jp", "bugtrack_url": null, "classifiers": [ "Framework :: Sphinx :: Extension", "Programming Language :: Python", "Topic :: Documentation :: Sphinx" ], "description": "\n===============================================================\n sphinx-docxbuilder\n\n An extension for a docx file generation with Sphinx-1.1.2\n\n Copyright(c) 2011, haraisao at gmail dot com\n===============================================================\n\nAbout this\n==========\nThis programs is an extension to generate a docx file with Sphinx-1.1.2.\nThis extension is developed by hacking both 'sphinxcontrib-docxbuilder' and 'python-docx'.\n\nSpecial thanks to Mike MacCana and Takayuki SHIMIZUKAWA.\n\nInformation\n=============\nAuther: Isao Hara\nHome Page: https://bitbucket.org/haraisao/sphinx-docxbuilder/\nKeywords: sphinx,extension,builder,docx,OpenXML \nLicense: MIT \n\nFiles\n=====\nThis program is consist of following files.\n\n* builder.py\n This file defined a builder class for Sphinx-1.1.2. This file is copyed from sphinx-docxbuilder's one.\n\n* writer.py\n This file defined a writer class for Sphinx-1.1.2. This file is modified sphinx-docxbuilder's.\n\n* highlight.py\n This file defined DocxFormatter and DocxPygmentsBridge to support highlighting in the literal block.\n\n* docx/docx.py\n This file defined two classes to manipulate a docx file.\n\n* docx/style.docx\n This is a default style file.\n If you customize a docx document when you generate sphinx-docxbuilder, please copy this file in a local directory and modify styles with MS Word.\n\n* contrib/quickstart.py\n This is for 'sphinx-quickstart' command to add some definitions for 'sphinx-docxbuilder'.\n Please replace the original one.\n\n* contrib/exportDocx.py contrib/restructDocx.py\n These are sample command to export/restruct docx file.\n\nRequirements\n=============\n* Python2.6 or later\n* lxml module\n* PIL(Python Imaging Library) module \n* Optionally, you need MS Word 2007 or later to modify a style file. \n\nFeatures\n==========\nCurrently it works followings:\n\n* Headings\n* Bullet List\n* Enumerated Lists\n* Definition Lists\n* Field Lists (simple text only)\n* Literal Blocks\n* High Lighing in Literal Blocks\n* Line Blocks\n* Block Quotes\n* Option Lists (simple text only)\n* Simple table and csv table\n* Images\n* Admonitions\n* Basic Inline Markups \n\nKnown issue\n============\nMany sphinx syntaxes and directives aren't tested yet.\n\n\nQuick Start\n=============\nSetup\n-----\nFirst of all, download or hg clone sphix-docxbuilder archive and extract all files into $(SPHINX_EGG_DIR)/sphinx-docxbuilder .\nUsage\n\nSet 'sphinx-docxbuilder' to 'extensions' line of target sphinx source\nconf.py ::\n\n extensions = ['sphinx-docxbuilder']\n\nExecute sphinx-build with below option ::\n\n $ sphinx-build -b docx [input-dir] [output-dir]\n\nCustomize Style file\n---------------------\nIf you want to customize output file, only you have to do is to change named styles in 'sphinx-doc/docx/style.docx' .\n\nCustomize document properties\n-----------------------------\nsphinx-docxbuilder support to customize document properties. Currently, you can set 'title','subject','creator','company','category','descriptions','keyword' to append expressions to 'conf.py'.\n\nFor example, to set the creator and the keyword properties, you add follows ::\n\n docx_creator = 'Isao HARA'\n docx_keywords = ['Sphinx', 'OpenXML']\n\nFuthermore, you can use your original style file to set following expressions to 'conf.py'. ::\n\n docx_style = 'MyStyle.docx'\n\n\n\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Lightslayer/sphinx-docxbuilder", "keywords": "", "license": "MIT License", "maintainer": "Liam Deacon", "maintainer_email": "liam.m.deacon@gmail.com", "name": "sphinx-docxbuilder", "package_url": "https://pypi.org/project/sphinx-docxbuilder/", "platform": "", "project_url": "https://pypi.org/project/sphinx-docxbuilder/", "project_urls": { "Homepage": "https://github.com/Lightslayer/sphinx-docxbuilder" }, "release_url": "https://pypi.org/project/sphinx-docxbuilder/2019.1.28.post1/", "requires_dist": [ "lxml", "pillow" ], "requires_python": ">=2.7", "summary": "An extension for a docx file generation with Sphinx (Fork of https://bitbucket.org/haraisao/sphinx-docxbuilder)", "version": "2019.1.28.post1" }, "last_serial": 4750321, "releases": { "2019.1.28": [ { "comment_text": "", "digests": { "md5": "7283e3e2a58e6882c19d81f86420e113", "sha256": "6c85d24e9545a7fbc2bd77a21d874673e5257a0bad488823a624d2739ea5b89b" }, "downloads": -1, "filename": "sphinx_docxbuilder-2019.1.28-py3-none-any.whl", "has_sig": false, "md5_digest": "7283e3e2a58e6882c19d81f86420e113", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 40261, "upload_time": "2019-01-28T07:29:10", "url": "https://files.pythonhosted.org/packages/1b/66/da60fc2863c5f9a1be4c062eb62077643721f7aff2bafb49e4b766f747b7/sphinx_docxbuilder-2019.1.28-py3-none-any.whl" } ], "2019.1.28.post1": [ { "comment_text": "", "digests": { "md5": "d0ca97a6aec1fc271acb562f89a81ff6", "sha256": "3d8253e94db92ce9421ee761f4eebe38ac7f81acedc8f68d338f99cd73572d9e" }, "downloads": -1, "filename": "sphinx_docxbuilder-2019.1.28.post1-py3-none-any.whl", "has_sig": false, "md5_digest": "d0ca97a6aec1fc271acb562f89a81ff6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 75182, "upload_time": "2019-01-28T14:02:09", "url": "https://files.pythonhosted.org/packages/5f/11/235beae40f0f1ec79a4e9f1430bca0319812b06efdd1bcf8e1747d08caa3/sphinx_docxbuilder-2019.1.28.post1-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d0ca97a6aec1fc271acb562f89a81ff6", "sha256": "3d8253e94db92ce9421ee761f4eebe38ac7f81acedc8f68d338f99cd73572d9e" }, "downloads": -1, "filename": "sphinx_docxbuilder-2019.1.28.post1-py3-none-any.whl", "has_sig": false, "md5_digest": "d0ca97a6aec1fc271acb562f89a81ff6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=2.7", "size": 75182, "upload_time": "2019-01-28T14:02:09", "url": "https://files.pythonhosted.org/packages/5f/11/235beae40f0f1ec79a4e9f1430bca0319812b06efdd1bcf8e1747d08caa3/sphinx_docxbuilder-2019.1.28.post1-py3-none-any.whl" } ] }