{ "info": { "author": "Mariano Guerra", "author_email": "luismarianoguerra@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Topic :: Documentation", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: Text Processing", "Topic :: Text Processing :: Markup", "Topic :: Utilities" ], "description": "rst2html5 tools - RestructuredText to HTML5 + bootstrap css\n===========================================================\n\nWe all love rst and the ability to generate any format, but the rst2html tool generates really basic html and css.\n\nThis tool will generate newer, nicer, more readable markup and provide ways to modify the output with extensions like nice css\nthanks to twitter's bootstrap css or online presentations with deck.js\n\nget it\n------\n\nvia pip::\n\n pip install rst2html5-tools\n\nlocally::\n\n git clone https://github.com/marianoguerra/rst2html5.git\n cd rst2html5\n git submodule init\n git submodule update\n\n sudo python setup.py install\n\nuse it\n------\n\nto generate a basic html document::\n\n rst2html5 examples/slides.rst > clean.html\n\nto generate a set of slides using deck.js::\n\n rst2html5 --deck-js --pretty-print-code --embed-content examples/slides.rst > deck.html\n\nto generate a set of slides using reveal.js::\n\n rst2html5 --jquery --reveal-js --pretty-print-code examples/slides.rst > reveal.html\n\nto generate a set of slides using impress.js::\n\n rst2html5 --stylesheet-path=html5css3/thirdparty/impressjs/css/impress-demo.css --impress-js examples/impress.rst > output/impress.html\n\nto generate a page using bootstrap::\n\n rst2html5 --bootstrap-css --pretty-print-code --jquery --embed-content examples/slides.rst > bootstrap.html\n\nto higlight code with pygments::\n\n rst2html5 --pygments examples/codeblock.rst > code.html\n\nnote that you will have to add the stylesheet for the code to actually highlight, this just does the code parsing and html transformation.\n\nto embed images inside the html file to have a single .html file to distribute\nadd the --embed-images option.\n\npost processors support optional parameters, they are passed with a command\nline option with the same name as the post processor appending \"-opts\" at the\nend, for example to change the revealjs theme you can do::\n\n rst2html5 --jquery --reveal-js --reveal-js-opts theme=serif examples/slides.rst > reveal.html\n\nyou can also pass the base path to the theme css file::\n\n rst2html5 --jquery --reveal-js --reveal-js-opts theme=serif,themepath=~/mytheme examples/slides.rst > reveal.html\n\nit will look at the theme at ~/mytheme/serif.css\n\noptions are passed as a comma separated list of key value pairs separated with\nan equal sign, values are parsed as json, if parsing fails they are passed as\nstrings, for example here is an example of options::\n\n --some-processor-opts theme=serif,count=4,verbose=true,foo=null\n\nif a key is passed more than once that parameter is passed to the processor as a list of values, note that if only one value is passed it's passed as it is, the convenience function as_list is provided to handle this case if you want to always receive a list.\n\nto add custom js files to the resulting file you can use the --add-js post processor like this::\n\n rst2html5 slides.rst --add-js --add-js-opts path=foo.js,path=bar.js\n\nthat command will add foo.js and bar.js as scripts in the resulting html file.\n\nPretty Print Code Notes\n.......................\n\nenable it::\n\n --pretty-print-code\n\nadd language specific lexers::\n\n --pretty-print-code-opts langs=clj:erlang\n\nNote: you have to pass both options when passing opts to prettify like this::\n\n --pretty-print-code --pretty-print-code-opts langs=clj:erlang\n\nthat is, the name of the languages separated by colons, available lexers at the\nmoment of this writing are:\n\n* apollo\n* basic\n* clj\n* css\n* dart\n* erlang\n* go\n* hs\n* lisp\n* llvm\n* lua\n* matlab\n* ml\n* mumps\n* n\n* pascal\n* proto\n* rd\n* r\n* scala\n* sql\n* tcl\n* tex\n* vb\n* vhdl\n* wiki\n* xq\n* yaml\n\nyou can see the available lexers under html5css3/thirdparty/prettify/lang-\\*.js\n\nRevealJs Notes\n..............\n\nto print pass --reveal-js-opts printpdf=true, for example::\n\n rst2html5 --jquery --reveal-js --reveal-js-opts printpdf=true examples/slides.rst > reveal-print.html\n\nthis can be used to open with chrome or chromium and print as pdf as described here: https://github.com/hakimel/reveal.js#pdf-export\n\n\nMath Support\n------------\nUse the ``math`` role and directive to include inline math and block-level equations into your document::\n\n When :math`a \\ne 0`, there are two solutions to :math:`ax^2 + bx + c = 0`\n and they are\n\n .. math::\n\n x = {-b \\pm \\sqrt{b^2-4ac} \\over 2a}\n\nBoth of these support a basic subset of LaTeX_ syntax.\n\nBy default, MathJax_ is used for displaying math. You can choose a different output format using the ``--math-output`` command line option:\n\n* ``--math-output mathjax`` uses MathJax (the default)\n* ``--math-output html`` will use plain HTML + CSS\n* ``--math-output mathml`` will use MathML_\n* ``--math-output latex`` outputs raw LaTeX\n\nIf you use MathJax, you can use the ``--mathjax-url`` and ``-mathjax-config`` command line options to configure a custom MathJax JavaScript URL and to provide a file with a custom MathJax configuration, respectively.\n\nIf you use HTML + CSS output, you can use the ``--math-css`` command line option to configure a custom math stylesheet.\n\nNote that the old MathJax postprocessor (activated using ``--mathjax``) has been deprecated.\n\n.. _LaTeX: https://www.latex-project.org\n.. _MathJax: https://www.mathjax.org\n.. _MathML: https://en.wikipedia.org/wiki/MathML\n\n\nsee it\n------\n\nyou can see the examples from the above commands here:\n\n* http://marianoguerra.github.com/rst2html5/output/clean.html\n* http://marianoguerra.github.com/rst2html5/output/reveal.html\n* http://marianoguerra.github.com/rst2html5/output/deck.html\n* http://marianoguerra.github.com/rst2html5/output/impress.html\n* http://marianoguerra.github.com/rst2html5/output/bootstrap.html\n\nexample of video directive\n\n* http://marianoguerra.github.com/rst2html5/output/videos.html\n\n\ntest it\n-------\nWe use `tox `_ to run our test suite. After installing *tox* you can execute the tests by running ``tox`` in the project's root directory.\n\nThe test cases can be found in ``html5css3/tests.py``.\n\n\nwant to contribute ?\n--------------------\n\nclone and send us a pull request! ::\n\n git clone https://github.com/marianoguerra/rst2html5.git\n cd rst2html5\n git submodule update --init\n python setup.py develop\n\nnote to self to release\n-----------------------\n\n* update version on setup.py\n\n::\n\n python setup.py sdist upload", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/marianoguerra/rst2html5", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "rst2html5-tools", "package_url": "https://pypi.org/project/rst2html5-tools/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/rst2html5-tools/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/marianoguerra/rst2html5" }, "release_url": "https://pypi.org/project/rst2html5-tools/0.5.3/", "requires_dist": null, "requires_python": null, "summary": "Transform reStructuredText documents to html5 + twitter's bootstrap css, deck.js or reveal.js", "version": "0.5.3" }, "last_serial": 2614486, "releases": { "0.2": [ { "comment_text": "", "digests": { "md5": "023a78de8abe38a9e8cc3199edc5d5a9", "sha256": "122124a5aa155086b92b9fa8c51493819a9f882b4552165d43c851a326780850" }, "downloads": -1, "filename": "rst2html5-tools-0.2.tar.gz", "has_sig": false, "md5_digest": "023a78de8abe38a9e8cc3199edc5d5a9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 71836, "upload_time": "2014-09-15T15:01:05", "url": "https://files.pythonhosted.org/packages/b0/6f/ae4ee199774b5fc1707cafd9c1a79f38ec79dcd5d8dcfb6be9334bcbbcb0/rst2html5-tools-0.2.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "3e36798d159a64a032ae88a60633d38d", "sha256": "78a801a4842dbcfc4cb05b9d23125fbb1a2bd040788164a6159c6914848f6f8a" }, "downloads": -1, "filename": "rst2html5-tools-0.2.1.tar.gz", "has_sig": false, "md5_digest": "3e36798d159a64a032ae88a60633d38d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 72024, "upload_time": "2014-09-15T21:12:38", "url": "https://files.pythonhosted.org/packages/02/86/5a536876206f07334de7e7deed92f998ba09c69d3d666362820bc1069f27/rst2html5-tools-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "cc42c01167f6430c8a1b89820be011a2", "sha256": "444cdb87207b9fa47c899ed08fb8316436665857599eae99d0c34cf23e9bed9f" }, "downloads": -1, "filename": "rst2html5-tools-0.2.2.tar.gz", "has_sig": false, "md5_digest": "cc42c01167f6430c8a1b89820be011a2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 337221, "upload_time": "2014-10-06T07:38:20", "url": "https://files.pythonhosted.org/packages/1e/a9/dfcc1ec9047170f9823057fe3b7b8527dd20080cdc3470879d451c73f300/rst2html5-tools-0.2.2.tar.gz" } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "467d9c64b7c5efaff9c1def05825a22d", "sha256": "0a8877d769738232984bc73ec4a80731cf5a3738f93b50ffaa5508b903fa09b2" }, "downloads": -1, "filename": "rst2html5-tools-0.2.4.tar.gz", "has_sig": false, "md5_digest": "467d9c64b7c5efaff9c1def05825a22d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 337406, "upload_time": "2014-12-08T13:58:22", "url": "https://files.pythonhosted.org/packages/8a/a9/90d46a504f6e2dd74162d7162dbc08908c1c7e7e5afaef4fc482c88e4941/rst2html5-tools-0.2.4.tar.gz" } ], "0.2.5": [ { "comment_text": "", "digests": { "md5": "9ccff1112892c5bc382dd4e1584cd7ac", "sha256": "5fec42f530a89957f937ce08b9d8e00896287152b279de36ea8737663123c346" }, "downloads": -1, "filename": "rst2html5-tools-0.2.5.tar.gz", "has_sig": false, "md5_digest": "9ccff1112892c5bc382dd4e1584cd7ac", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 337865, "upload_time": "2015-01-02T13:25:59", "url": "https://files.pythonhosted.org/packages/96/13/b52395572b039851a9eb82c7e77a4db96d9883f4c2f4f6c1c73cbb6963bb/rst2html5-tools-0.2.5.tar.gz" } ], "0.2.6": [ { "comment_text": "", "digests": { "md5": "ce155d6862ffde776fcb4d5272e3df69", "sha256": "a4274e416b4c2b351ff806d2e163eda5f1be6eb29101fb7689ff3baf8ba75372" }, "downloads": -1, "filename": "rst2html5-tools-0.2.6.tar.gz", "has_sig": false, "md5_digest": "ce155d6862ffde776fcb4d5272e3df69", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 337954, "upload_time": "2015-05-18T13:11:44", "url": "https://files.pythonhosted.org/packages/57/40/d79606e4a9642f3faec9d799df240f6a8de92b9d03f28d99c855b112bbda/rst2html5-tools-0.2.6.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "c57fec739943c4d8373aa88fe62b88bc", "sha256": "9e3d9be01e6b0688e9a07c81578cdbfa1397b7768aae33185e69c47c277359ef" }, "downloads": -1, "filename": "rst2html5-tools-0.3.0.tar.gz", "has_sig": false, "md5_digest": "c57fec739943c4d8373aa88fe62b88bc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1787347, "upload_time": "2015-11-10T14:20:29", "url": "https://files.pythonhosted.org/packages/81/ae/0086fa21f49b36e89bb43db6231156141ea24e3324ee84da4771f28df184/rst2html5-tools-0.3.0.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "8d2dfbb23f203d99e72baddacbddf8f0", "sha256": "850cddfb95c14bf7a276553ae8daab8073edf716d9cd364dc9ef5f00685bc3f9" }, "downloads": -1, "filename": "rst2html5-tools-0.4.0.tar.gz", "has_sig": false, "md5_digest": "8d2dfbb23f203d99e72baddacbddf8f0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1793487, "upload_time": "2015-12-16T15:46:40", "url": "https://files.pythonhosted.org/packages/10/59/d73e7ca0701ddd87e8c9a47b30c49844fdfcc31db91e96ecf59fd60e1de4/rst2html5-tools-0.4.0.tar.gz" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "db8c9e2ce7f053bbd28b52ab31c56cbb", "sha256": "943d9012330866ed8efbbe4d09b9c1e4b70812623afddc6d5d690048ff81df78" }, "downloads": -1, "filename": "rst2html5-tools-0.5.0.tar.gz", "has_sig": false, "md5_digest": "db8c9e2ce7f053bbd28b52ab31c56cbb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1830414, "upload_time": "2016-02-18T13:03:48", "url": "https://files.pythonhosted.org/packages/86/52/537bac6f1c314158e3e4bb5f08d2c9a599251ac5bd411f713fc06c9c0566/rst2html5-tools-0.5.0.tar.gz" } ], "0.5.1": [ { "comment_text": "", "digests": { "md5": "60ab32c1ce7b786093c0bbf429fe7efd", "sha256": "c229700e0f74862994dd9c68253a65fc12229e5ec4c4dbaeeada1bfe7852c2d5" }, "downloads": -1, "filename": "rst2html5-tools-0.5.1.tar.gz", "has_sig": false, "md5_digest": "60ab32c1ce7b786093c0bbf429fe7efd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1830523, "upload_time": "2016-07-05T17:11:03", "url": "https://files.pythonhosted.org/packages/8d/b7/3aa830bd1f79ab88ab5e484ab7d52ffaf007802cc7ab1eff23b391fb6a5e/rst2html5-tools-0.5.1.tar.gz" } ], "0.5.2": [ { "comment_text": "", "digests": { "md5": "9c80290e95d26ae62da5716e40a693c6", "sha256": "03e349a45af2e12c8f9c670496e93dd7a7b28cca92744649853f38759d9c66b9" }, "downloads": -1, "filename": "rst2html5-tools-0.5.2.tar.gz", "has_sig": false, "md5_digest": "9c80290e95d26ae62da5716e40a693c6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 528509, "upload_time": "2016-09-28T18:57:16", "url": "https://files.pythonhosted.org/packages/94/39/ed858164a1d7da9f7ba3f62cc6e33369b9df80d1de61352decabe90fed4e/rst2html5-tools-0.5.2.tar.gz" } ], "0.5.3": [ { "comment_text": "", "digests": { "md5": "076b829e96d1fe773059db30afb40414", "sha256": "5ef65862310af8018d2ebaf6b6a36b679fa4f10abf13fe9f38a31f450c4542c3" }, "downloads": -1, "filename": "rst2html5-tools-0.5.3.tar.gz", "has_sig": false, "md5_digest": "076b829e96d1fe773059db30afb40414", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 528555, "upload_time": "2017-02-02T14:58:45", "url": "https://files.pythonhosted.org/packages/b0/03/33e7fa1cae3153584b8a695ec0a55da8e972da161701903b9206169158c4/rst2html5-tools-0.5.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "076b829e96d1fe773059db30afb40414", "sha256": "5ef65862310af8018d2ebaf6b6a36b679fa4f10abf13fe9f38a31f450c4542c3" }, "downloads": -1, "filename": "rst2html5-tools-0.5.3.tar.gz", "has_sig": false, "md5_digest": "076b829e96d1fe773059db30afb40414", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 528555, "upload_time": "2017-02-02T14:58:45", "url": "https://files.pythonhosted.org/packages/b0/03/33e7fa1cae3153584b8a695ec0a55da8e972da161701903b9206169158c4/rst2html5-tools-0.5.3.tar.gz" } ] }