{ "info": { "author": "Andr\u00e9 Felipe Dias", "author_email": "andref.dias@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "Intended Audience :: Education", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Topic :: Documentation", "Topic :: Text Processing :: Markup :: HTML", "Topic :: Utilities" ], "description": "===============\nrst2html5slides\n===============\n\n rst2html5slides extends rst2html5_ to translate a reStructuredText file\n into a web presentation.\n\nRationale\n=========\n\nPresentations based on web frameworks such as `impress.js`_, `jmpress.js`_ and `deck.js`_\nare great alternatives to traditional software packages:\n\n#. HTML, CSS and javascript files are plain text files and thus\n they are friendly to version control systems,\n making easy to follow and visualize their changes between revisions;\n#. There is a separation between content and presentation design\n#. They have new and great visual effects such as slide transitions and positional effects\n#. A web presentation is portable. It runs on any modern browser\n\nOn the other hand,\ncreating presentations directly in HTML is painful.\nA better approach is to use another markup language that is easier to read and write,\nand then translate the text to HTML.\n\nI could have listed or cooked up a few reasons to justify reStructuredText_ as the best choice.\nThe truth is that the best markup language is the one you already know.\nSo, if you also use reStructuredText in other projects or contexts,\nthen :literal:`rst2html5slides` is perfect for you to create your presentations.\n\n\nFeatures\n========\n\n* CSS can be extended or overwritten by adding new stylesheets;\n* Slides can be positioned manually or automatically through pre-defined functions\n (:literal:`linear`, :literal:`grid` and :literal:`grid-rotate`);\n\n\nInstallation\n============\n\n.. code-block:: bash\n\n pip install rst2html5slides\n\n\nBasic Usage\n===========\n\n.. code-block:: bash\n\n $ rst2html5slides [OPTIONS] SOURCE [DESTINATION]\n\n\nIf no destination is given, then the presentation is written to the *stdout*.\nElse, the presentation and all related files (images, CSS, scripts etc.)\nare written into the specified path.\n\nOptions:\n\n--presentation=\n Choose a web presentation framework for the output.\n Possible values are impress.js, jmpress.js, deck.js,\n None. Default is impress.js.\n--distribution=\n Specify the name of the slide distribution function.\n Options are \"linear\", \"grid\" or \"grid-rotate\". An\n additional parameter can be specified along with the\n name such as in \"grid_rotate 3\".\n--increment=\n Specify the value of the increment used by the\n distribution functions. To specify different values\n for X and Y increments, separate them by space.\n Example \"1000 500\". Default value is 1600 for X and Y\n increments.\n--manual-slide-id Disable slide automatic identification based on title.\n--deck-selector=\n Specify the tag, id and/or class to replace the\n default (and non-standard) tag used to surround\n the slides. Follow the pattern tag#id.class (such as a\n CSS selector). Examples: div, div#impress, div.deck-\n container, article#impress.impress-not-supported\n--slide-selector=\n Specify the tag, id and/or class to replace the\n default (and non-standard) tag used to\n surround each slide.Follow the pattern tag#id.class\n (such as a CSS selector)Examples: div.slide, section,\n div.step\n\n.. tip::\n\n All rst2html5_ options can be used with :literal:`rst2html5slides` such as\n :literal:`--stylesheet` and :literal:`--script`.\n\n.. note::\n\n :literal:`--deck-selector` and :literal:`--slide-selector` are only required for advanced usage.\n See the full documentation for additional information.\n\n\nExample\n=======\n\n:literal:`simple.rst`:\n\n.. code-block:: rst\n\n .. title:: Simple Presentation | rst2html5slides\n .. meta::\n :author: Andr\u00e9 Felipe Dias\n\n .. class:: cover\n\n Presentation\n ============\n\n Author\n ------\n\n Topic 1\n =======\n\n * item A\n * item B\n\n Topic 2\n =======\n\n * item C\n * item D\n\n\nTo translate it to a presentation located at :literal:`/tmp/slides`,\nuse this command:\n\n.. code-block:: bash\n\n $ rst2html5slides simple.rst /tmp/slides\n\n\nThe generated file is:\n\n.. code-block:: html\n\n \n \n \n \n \n \n \n \n \n\n \n \n \n\n \n \n\n \n \n
\n

Presentation

\n

Author

\n
\n
\n \n
\n

Topic 1

\n
\n
\n
    \n
  • item A
  • \n
  • item B
  • \n
\n
\n
\n \n
\n

Topic 2

\n
\n
\n
    \n
  • item C
  • \n
  • item D
  • \n
\n
\n
\n
\n\n \n \n\n\nrst2html5slides copies all referenced files (images, additional scripts and css)\nto the destination path:\n\n.. code-block:: bash\n\n $ ls -R /tmp/slides\n /tmp/slides:\n css js simple.html\n\n /tmp/slides/css:\n slideshow.css\n\n /tmp/slides/js:\n greensock jquery.min.js slide_animations.js slideshow.js video_animation.js\n\n\n\n.. note::\n\n You can customize your presentation adding CSS files, scripts or\n changing the default template.\n See the full documentation for more information.\n\n\nDocumentation\n=============\n\nThe full documentation is available at readthedocs.org and also in the :literal:`doc` subdirectory.\n\n\nSource\n======\n\nrst2html5slides source is located at http://bitbucket.org/andre_felipe_dias/rst2html5slides\n\n\nLicense\n=======\n\nrst2html5slides is available under a MIT license.\n\n\n.. _rst2html5: https://pypi.python.org/pypi/rst2html5\n.. _reStructuredText: http://docutils.sourceforge.net/rst.html\n.. _JQuery: http://jquery.com/\n.. _impress.js: http://github.com/bartaz/impress.js\n.. _jmpress.js: http://jmpressjs.github.io/jmpress.js/\n.. _deck.js: http://imakewebthings.com/deck.js/\n\n=========\nChangelog\n=========\n\n\n1.2.2 - 2018-11-17\n==================\n\n* Fix setup.py\n* Reorganize project structure\n\n\n1.2.1 - 2018-11-14\n==================\n\n* Fix installation and dependencies\n\n\n1.2 - 2018-11-06\n================\n\n* Fix README.rst\n* Fix version exhibition\n* Fix some PEP8 warnings\n* Fix tests comparing expected and obtained results\n* requirements.txt replaced by pipenv\n* Update project to work with rst2htm5 1.9.5\n\n1.1 - 2018-11-06\n================\n\n* Update project to work with rst2htm5 1.9.4\n* Slideshow is based on GreenSock Animation Platform (GSAP)\n\n1.0 - 2014-09-21\n================\n\n* First public preview release\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "", "keywords": "restructuredText,slide,docutils,presentation,html5", "license": "MIT License", "maintainer": "", "maintainer_email": "", "name": "rst2html5slides", "package_url": "https://pypi.org/project/rst2html5slides/", "platform": "any", "project_url": "https://pypi.org/project/rst2html5slides/", "project_urls": null, "release_url": "https://pypi.org/project/rst2html5slides/1.2.2/", "requires_dist": [ "docutils (>=0.14)", "genshi (>=0.7)", "micawber (>=0.3.5)", "rst2html5 (>=1.9.5)" ], "requires_python": "", "summary": "rst2html5slides generates a slideshow from a reStructuredText file.", "version": "1.2.2" }, "last_serial": 4495853, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "d941da3705f111f9809bae029b846ef2", "sha256": "2cab5ed44c00dadb14fc79151590ea9e6e989eb728592aca93d0faf03a412a75" }, "downloads": -1, "filename": "rst2html5slides-1.0-py2.7.egg", "has_sig": false, "md5_digest": "d941da3705f111f9809bae029b846ef2", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 16133, "upload_time": "2018-11-06T11:01:52", "url": "https://files.pythonhosted.org/packages/80/12/58bec833ea0d8211b7d9ec98e6bc5fb9cc50b0047350569c9bba8b87872a/rst2html5slides-1.0-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "4d23f1b1fe5fa39de70fb255b51dc929", "sha256": "5590ebef900e1346deff85dc1f67cf95fbf92f068b742e7df88ead1e97b9faeb" }, "downloads": -1, "filename": "rst2html5slides-1.0-py3.4.egg", "has_sig": false, "md5_digest": "4d23f1b1fe5fa39de70fb255b51dc929", "packagetype": "bdist_egg", "python_version": "3.4", "requires_python": null, "size": 106418, "upload_time": "2018-11-06T11:01:54", "url": "https://files.pythonhosted.org/packages/db/44/6a14d27c74d55f2eaddba132cc1b5d284f631dacc211b125c49f06f7bc64/rst2html5slides-1.0-py3.4.egg" }, { "comment_text": "", "digests": { "md5": "a3fad0e9424bbf1ea98398fbb8bc18f3", "sha256": "0fb56f1e53f81c2e6c5502b231018ff242c52ca7a70f711d4532ea26fd8d9489" }, "downloads": -1, "filename": "rst2html5slides-1.0-py3.5.egg", "has_sig": false, "md5_digest": "a3fad0e9424bbf1ea98398fbb8bc18f3", "packagetype": "bdist_egg", "python_version": "3.5", "requires_python": null, "size": 162867, "upload_time": "2018-11-06T11:01:56", "url": "https://files.pythonhosted.org/packages/c0/e2/9f9f27e84ea0abdf4245e1bc1e82d004c7e79a5ce45a7c721c6c93b0f916/rst2html5slides-1.0-py3.5.egg" }, { "comment_text": "", "digests": { "md5": "3fbed3d01e1a4711746db729c9454660", "sha256": "8168e84dc3102b4895e42f3600783c3c918509d53283f81772135000f0455947" }, "downloads": -1, "filename": "rst2html5slides-1.0-py3.6.egg", "has_sig": false, "md5_digest": "3fbed3d01e1a4711746db729c9454660", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 165323, "upload_time": "2018-11-06T11:01:58", "url": "https://files.pythonhosted.org/packages/f3/a4/c9172f15c88a9d92685975a5633168ac8cbb77ab91c4979b22a7f86627ca/rst2html5slides-1.0-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "bd86c69ecb282b90cc75849828c7c470", "sha256": "2f9ded75a22a5df943f375b8b4ba8f28a6e9b4c9903e856a81f93348cbcfbb26" }, "downloads": -1, "filename": "rst2html5slides-1.0.tar.gz", "has_sig": false, "md5_digest": "bd86c69ecb282b90cc75849828c7c470", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11790, "upload_time": "2014-10-13T13:54:56", "url": "https://files.pythonhosted.org/packages/2c/48/9f334a6b59bbc4433c8dda83af782ace09a8730d9943798e446b356540ee/rst2html5slides-1.0.tar.gz" }, { "comment_text": "", "digests": { "md5": "86189697b31266a92f91bb0178cac8fb", "sha256": "ce826133439817e12d90b33684023dfdb319efee0a610c23f4d6f45111f0162c" }, "downloads": -1, "filename": "rst2html5slides-1.0.zip", "has_sig": false, "md5_digest": "86189697b31266a92f91bb0178cac8fb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18667, "upload_time": "2014-10-13T13:54:59", "url": "https://files.pythonhosted.org/packages/c7/1b/44b9c1a508902a8ed514e07d92f2ecff4f791eace68e615246d668fec594/rst2html5slides-1.0.zip" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "e3e3a8413d0d42df3469922491a89d68", "sha256": "53fccc5315e0adaf0a6cd7e086d1fb14108ecf30a5bb804df1a5b81507234ee3" }, "downloads": -1, "filename": "rst2html5slides-1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e3e3a8413d0d42df3469922491a89d68", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 168252, "upload_time": "2018-11-06T11:01:50", "url": "https://files.pythonhosted.org/packages/90/50/b98264d9132c91e7eef96657864b8a61da49abdd62381f58d79f6e0fad05/rst2html5slides-1.1-py2.py3-none-any.whl" } ], "1.2": [ { "comment_text": "", "digests": { "md5": "a7298a8f6ff99c35c26fae907752c238", "sha256": "8e45922f04630efc40b8ec3725620ddea54df5b988f1530344a56843c1bb220e" }, "downloads": -1, "filename": "rst2html5slides-1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a7298a8f6ff99c35c26fae907752c238", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 164276, "upload_time": "2018-11-06T16:58:36", "url": "https://files.pythonhosted.org/packages/a8/18/27bee48f7f5b165638f6c4ea2fca83a1043d839d5d506deea5c2e36dd67a/rst2html5slides-1.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "311ed4da2c91de6f2f36bed1a9be49cb", "sha256": "bce2033e7cfe30cc88278d59c463375a38b4c67bcaa59d2c3ca74646c1860bcb" }, "downloads": -1, "filename": "rst2html5slides-1.2.tar.gz", "has_sig": false, "md5_digest": "311ed4da2c91de6f2f36bed1a9be49cb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 156727, "upload_time": "2018-11-06T16:58:38", "url": "https://files.pythonhosted.org/packages/62/09/68e1d7a93cbe16644dbb443adfdcbfcfbe480d9fb19787b311353698753d/rst2html5slides-1.2.tar.gz" } ], "1.2.1": [ { "comment_text": "", "digests": { "md5": "3d98ff0829bd329132c475bf5a05fc30", "sha256": "36df22a1cf941f87bc01a02dce7df55860464bdecceb964b08b2682a53dd5e6d" }, "downloads": -1, "filename": "rst2html5slides-1.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "3d98ff0829bd329132c475bf5a05fc30", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 168567, "upload_time": "2018-11-14T10:24:53", "url": "https://files.pythonhosted.org/packages/26/9b/d60638766b3415602927eee094c647c825f1b9d25b49d10751e9c3389605/rst2html5slides-1.2.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4276f231285dcd6ecddc1a4d9c3b17d5", "sha256": "158e67e03ccdfad87a133b25e665345ccdac78860b140bf5eee9281f9996c9d4" }, "downloads": -1, "filename": "rst2html5slides-1.2.1.tar.gz", "has_sig": false, "md5_digest": "4276f231285dcd6ecddc1a4d9c3b17d5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 156809, "upload_time": "2018-11-14T10:24:56", "url": "https://files.pythonhosted.org/packages/69/c3/2b3653b53898aef53a4126aebe4d269f390332df8a75a0a2cfa877e427dd/rst2html5slides-1.2.1.tar.gz" } ], "1.2.2": [ { "comment_text": "", "digests": { "md5": "ef05c6fc446996ede4b3a6e6b3eab1f5", "sha256": "d417782dfdb1ad3e6cd117670263d90e9b6bef1f6a08768a1c4ab85a94864248" }, "downloads": -1, "filename": "rst2html5slides-1.2.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ef05c6fc446996ede4b3a6e6b3eab1f5", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 179156, "upload_time": "2018-11-17T03:39:20", "url": "https://files.pythonhosted.org/packages/9e/a2/643e762d224c49677f84b07e0ca14af11702f0a538bca981b464bc40d072/rst2html5slides-1.2.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "20bee0030b9c35def165cf57486c5ced", "sha256": "740dc708ee84c92a0c82a8568ea1b53da1f68b38080add11b5b5a2fa6d74763d" }, "downloads": -1, "filename": "rst2html5slides-1.2.2.tar.gz", "has_sig": false, "md5_digest": "20bee0030b9c35def165cf57486c5ced", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 155122, "upload_time": "2018-11-17T03:39:23", "url": "https://files.pythonhosted.org/packages/8b/ef/28178ec89342ad2e9e4dfe273ee2fea60bb6b7f3203d6e7111f368b81f2c/rst2html5slides-1.2.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ef05c6fc446996ede4b3a6e6b3eab1f5", "sha256": "d417782dfdb1ad3e6cd117670263d90e9b6bef1f6a08768a1c4ab85a94864248" }, "downloads": -1, "filename": "rst2html5slides-1.2.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ef05c6fc446996ede4b3a6e6b3eab1f5", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 179156, "upload_time": "2018-11-17T03:39:20", "url": "https://files.pythonhosted.org/packages/9e/a2/643e762d224c49677f84b07e0ca14af11702f0a538bca981b464bc40d072/rst2html5slides-1.2.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "20bee0030b9c35def165cf57486c5ced", "sha256": "740dc708ee84c92a0c82a8568ea1b53da1f68b38080add11b5b5a2fa6d74763d" }, "downloads": -1, "filename": "rst2html5slides-1.2.2.tar.gz", "has_sig": false, "md5_digest": "20bee0030b9c35def165cf57486c5ced", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 155122, "upload_time": "2018-11-17T03:39:23", "url": "https://files.pythonhosted.org/packages/8b/ef/28178ec89342ad2e9e4dfe273ee2fea60bb6b7f3203d6e7111f368b81f2c/rst2html5slides-1.2.2.tar.gz" } ] }