{
"info": {
"author": "Sanhe Hu",
"author_email": "husanhe@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Natural Language :: English",
"Operating System :: MacOS",
"Operating System :: Microsoft :: Windows",
"Operating System :: Unix",
"Programming Language :: Python",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3.4",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6"
],
"description": ".. image:: https://readthedocs.org/projects/rstobj/badge/?version=latest\n :target: https://rstobj.readthedocs.io/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://travis-ci.org/MacHu-GWU/rstobj-project.svg?branch=master\n :target: https://travis-ci.org/MacHu-GWU/rstobj-project?branch=master\n\n.. image:: https://codecov.io/gh/MacHu-GWU/rstobj-project/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/MacHu-GWU/rstobj-project\n\n.. image:: https://img.shields.io/pypi/v/rstobj.svg\n :target: https://pypi.python.org/pypi/rstobj\n\n.. image:: https://img.shields.io/pypi/l/rstobj.svg\n :target: https://pypi.python.org/pypi/rstobj\n\n.. image:: https://img.shields.io/pypi/pyversions/rstobj.svg\n :target: https://pypi.python.org/pypi/rstobj\n\n.. image:: https://img.shields.io/pypi/dm/rstobj.svg\n :target: https://pypi.python.org/pypi/rstobj\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/rstobj-project\n\n------\n\n\n.. image:: https://img.shields.io/badge/Link-Document-blue.svg\n :target: https://rstobj.readthedocs.io/index.html\n\n.. image:: https://img.shields.io/badge/Link-API-blue.svg\n :target: https://rstobj.readthedocs.io/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Source_Code-blue.svg\n :target: https://rstobj.readthedocs.io/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n :target: https://github.com/MacHu-GWU/rstobj-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n :target: https://github.com/MacHu-GWU/rstobj-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n :target: https://github.com/MacHu-GWU/rstobj-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n :target: https://pypi.org/pypi/rstobj#files\n\n\nWelcome to ``rstobj`` Documentation\n==============================================================================\n\n``rstobj`` is a library that construct Restructured Text markup or directives from Python Code. ``rstobj`` is based on ``jinja2``.\n\n**The idea behind rstobj**:\n\nRestructuredText is super powerful, way more powerful than markdown. But have you ever think of **customize YOUR OWN markup or directive and do some magic?**\n\n`Sphinx Doc `_ is the ultimate doc build tool. With ``rstobj``, you can **easily create your own markup / directive, and hide complex workflow behind a single markup / directive**, then use it when you need it. Here's some ideas:\n\n1. Use ``.. include-all-image::`` to automatically scan image file under a directory, create ``.. image::`` directive and organize everything in a table.\n2. Separate comment and value of the config file, automatically create an document for a config file.\n3. ...\n\nI have a `Blog Post `_ to share how to create a sphinx doc extension in 50 lines and customize your own directive (Sorry, its written in Chinese).\n\n\n**Example**:\n\n.. code-block:: python\n\n import rstobj # or from rstobj import *\n\n header = rstobj.markup.Header(title=\"Section1\", header_level=1, auto_label=True)\n rst_header = header.render()\n print(rst_header)\n\n ltable = rstobj.directives.ListTable(\n data=[[\"id\", \"name\"], [1, \"Alice\"], [2, \"Bob\"]],\n title=\"Users\",\n header=True,\n )\n rst = ltable.render()\n print(rst_ltable)\n\nOutput::\n\n .. _section1:\n\n Section1\n ========\n\n .. list-table:: Users\n :header-rows: 1\n :stub-columns: 0\n\n * - id\n - name\n * - 1\n - Alice\n * - 2\n - Bob\n\nI recommend to use this in your jinja2 template, content of ``outut.rst``::\n\n {{ header.render() }}\n {{ ltable.render() }}\n\nAnd use ``rstobj`` with ``sphinx-jinja`` library https://pypi.org/project/sphinx-jinja/ in sphinx doc project.\n\n**Supported directives**:\n\n- ``.. image::``\n- ``.. list-table::``\n- ``.. contents::``\n- ``.. code-block::``\n- ``.. include::``\n\n**Supported markup**:\n\n- ``Header``::\n\n .. _ref-label:\n\n Title\n =====\n\n- ``URL``: ```Text `_``\n- ``Reference``: ``:ref:`Text ```\n\n\n**If you need more features, please submit an issue to** https://github.com/MacHu-GWU/rstobj-project/issues\n\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``rstobj`` is released on PyPI, so all you need is:\n\n.. code-block:: console\n\n $ pip install rstobj\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n $ pip install --upgrade rstobj\n\n",
"description_content_type": "",
"docs_url": null,
"download_url": "https://pypi.python.org/pypi/rstobj/0.0.7#downloads",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/MacHu-GWU/",
"keywords": "",
"license": "MIT",
"maintainer": "Sanhe Hu",
"maintainer_email": "husanhe@gmail.com",
"name": "rstobj",
"package_url": "https://pypi.org/project/rstobj/",
"platform": "Windows",
"project_url": "https://pypi.org/project/rstobj/",
"project_urls": {
"Download": "https://pypi.python.org/pypi/rstobj/0.0.7#downloads",
"Homepage": "https://github.com/MacHu-GWU/"
},
"release_url": "https://pypi.org/project/rstobj/0.0.7/",
"requires_dist": [
"six",
"jinja2",
"attrs",
"attrs-mate",
"sphinx (==1.8.1) ; extra == 'docs'",
"sphinx-rtd-theme ; extra == 'docs'",
"sphinx-jinja ; extra == 'docs'",
"sphinx-copybutton ; extra == 'docs'",
"docfly (==0.0.17) ; extra == 'docs'",
"rstobj ; extra == 'docs'",
"pygments ; extra == 'docs'",
"pytest (==3.2.3) ; extra == 'tests'",
"pytest-cov (==2.5.1) ; extra == 'tests'"
],
"requires_python": "",
"summary": "Construct RestructuredText markup and directives from Python Code.",
"version": "0.0.7"
},
"last_serial": 5315255,
"releases": {
"0.0.1": [
{
"comment_text": "",
"digests": {
"md5": "cf2607717f6f66d41d04a3afe66a957a",
"sha256": "acaf5b7f0d02c69c41c86af2b2df2435d9ff9c5d47b6508760612fa30c1cc743"
},
"downloads": -1,
"filename": "rstobj-0.0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf2607717f6f66d41d04a3afe66a957a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 46313,
"upload_time": "2018-10-12T02:35:18",
"url": "https://files.pythonhosted.org/packages/01/51/1323f46d35cd5a6457d424f5504175e9f476d15ba439a97c504ed492a4fc/rstobj-0.0.1-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "e42e47700ac77f63874ea2359b2e35b9",
"sha256": "1b02f87c08f82b7f11c6b8cc2923a839178452c2c664a621d996108f9e4262cc"
},
"downloads": -1,
"filename": "rstobj-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "e42e47700ac77f63874ea2359b2e35b9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19585,
"upload_time": "2018-10-12T02:35:19",
"url": "https://files.pythonhosted.org/packages/7a/94/95f2c445beb11c72371847e4424608c5953f3fc78731ad6999dabe8e9642/rstobj-0.0.1.tar.gz"
}
],
"0.0.2": [
{
"comment_text": "",
"digests": {
"md5": "9aeaca322a8f26a3434cde1daead88df",
"sha256": "10eb58d3cb1d420acc8540549cdf8af808636d4dd5b612a1216d93d5a7b59413"
},
"downloads": -1,
"filename": "rstobj-0.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "9aeaca322a8f26a3434cde1daead88df",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 63258,
"upload_time": "2018-10-27T16:44:47",
"url": "https://files.pythonhosted.org/packages/44/a1/e77886c9673602080b6096d26519d010a47a96ff51c357fe74426242865d/rstobj-0.0.2-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "cd3aa8553e647973e146acd423e556f1",
"sha256": "e11ab9188826dd8e76763569bcc3e36fc91d1376ac56b1292e9c32eab46e3639"
},
"downloads": -1,
"filename": "rstobj-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "cd3aa8553e647973e146acd423e556f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26697,
"upload_time": "2018-10-27T16:44:49",
"url": "https://files.pythonhosted.org/packages/5d/78/c8d22ad4a46d9318af41277e291436a1fd6fdaaa1ea282ad890cd246650e/rstobj-0.0.2.tar.gz"
}
],
"0.0.3": [
{
"comment_text": "",
"digests": {
"md5": "8cbdc9d736f69075f07123d34db3f9e6",
"sha256": "2634da521878500faf9dc2685a2522ce60618941dfe5cbc0c16b9b0eaa88f92b"
},
"downloads": -1,
"filename": "rstobj-0.0.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "8cbdc9d736f69075f07123d34db3f9e6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 65464,
"upload_time": "2018-11-13T18:59:39",
"url": "https://files.pythonhosted.org/packages/c0/9f/a31c7f6c2a0075aebd6edda5dce53fa2e32316622b1e97f4441c16245a37/rstobj-0.0.3-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "d8f62bf5db85d0e20b6e68f9d1e963fe",
"sha256": "f79d6be8d9ed2cf9bf4f43abbd0507d4e5b171bb81bf841474a0f12e67a2c096"
},
"downloads": -1,
"filename": "rstobj-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "d8f62bf5db85d0e20b6e68f9d1e963fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27503,
"upload_time": "2018-11-13T18:59:41",
"url": "https://files.pythonhosted.org/packages/5e/ed/c0a9c473617b3fb846f696f82b5d257e4c3741ad055428fa2d7b699f3192/rstobj-0.0.3.tar.gz"
}
],
"0.0.4": [
{
"comment_text": "",
"digests": {
"md5": "55cdc6735d1f686d88f4ed79d04f185c",
"sha256": "709bba2e12b522a9c45608cb1b24284b092cc4fa60501b5eed998a14a3fc4688"
},
"downloads": -1,
"filename": "rstobj-0.0.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "55cdc6735d1f686d88f4ed79d04f185c",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 69017,
"upload_time": "2018-11-24T01:27:03",
"url": "https://files.pythonhosted.org/packages/c7/53/efc9e15bce7d5969a78a7f61219779892e2b5e029b90a13b90b51ab28bd4/rstobj-0.0.4-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "bdee22ede6643702019678ed82a30657",
"sha256": "a30e9081cf2b00ebd484d153e9bed5f49f3d0470010beb346fe4d036ce928b02"
},
"downloads": -1,
"filename": "rstobj-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "bdee22ede6643702019678ed82a30657",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28944,
"upload_time": "2018-11-24T01:27:05",
"url": "https://files.pythonhosted.org/packages/55/a4/bcfc38d2e10c0e14becdfa362b0cba5c4b8df4ef53caded474ba8e16691a/rstobj-0.0.4.tar.gz"
}
],
"0.0.5": [
{
"comment_text": "",
"digests": {
"md5": "23aff66fe8f5015390ccb380480674c1",
"sha256": "9a077cbcad7c2df749b9cbd9e08d7734138b3c32c6b04b8273be37206824f113"
},
"downloads": -1,
"filename": "rstobj-0.0.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "23aff66fe8f5015390ccb380480674c1",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 75150,
"upload_time": "2018-12-02T23:32:38",
"url": "https://files.pythonhosted.org/packages/6f/b9/fb7679ca6b36895e9de3a87873d75b32fddb926b0dff768f6d65c0544b40/rstobj-0.0.5-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "992b71594542644f2b8082ca1a87540a",
"sha256": "fa658eef2582e73003343c2c4ba7c0ccdd3e8fc88341a17e4b1f0f7ea32de6cd"
},
"downloads": -1,
"filename": "rstobj-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "992b71594542644f2b8082ca1a87540a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31461,
"upload_time": "2018-12-02T23:32:40",
"url": "https://files.pythonhosted.org/packages/10/7f/bcd612098d1906bd123bce255095f7e4225d591a722224cda3d82cf63512/rstobj-0.0.5.tar.gz"
}
],
"0.0.6": [
{
"comment_text": "",
"digests": {
"md5": "1aab7e4a416421d4ff52b017b77d3f75",
"sha256": "bd54ae0aebe1922d01155beee66dd56c13dc30b6e437754fa42f03a5d2acc765"
},
"downloads": -1,
"filename": "rstobj-0.0.6-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1aab7e4a416421d4ff52b017b77d3f75",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 96649,
"upload_time": "2019-01-09T22:18:18",
"url": "https://files.pythonhosted.org/packages/0b/1f/0af43db9199dcb47fa578981ba688d2bbdbb16d112175fe5635c1e3f95c5/rstobj-0.0.6-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "041cfda4a840752b480fac8ff4c4c632",
"sha256": "9a2c23a339fa565016d38e3b04f3618e10e76af62e8f567b5d8faf6d47122773"
},
"downloads": -1,
"filename": "rstobj-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "041cfda4a840752b480fac8ff4c4c632",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 40454,
"upload_time": "2019-01-09T22:18:20",
"url": "https://files.pythonhosted.org/packages/59/8b/525dbe190bd8fb245e32650d76aa08293416bd85e1fb1b8d045a37e786c3/rstobj-0.0.6.tar.gz"
}
],
"0.0.7": [
{
"comment_text": "",
"digests": {
"md5": "9ce7ddceb8467113856e0c50d0a987d6",
"sha256": "c53856969d7c03ea6fca8420b3111f61de778002c0c1ff60313650825b524f54"
},
"downloads": -1,
"filename": "rstobj-0.0.7-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ce7ddceb8467113856e0c50d0a987d6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 88095,
"upload_time": "2019-05-25T03:18:27",
"url": "https://files.pythonhosted.org/packages/1b/a4/696ac3be631bea437d3b2b254e69227cfe39a0d0c74da7b8747e3d65a3cc/rstobj-0.0.7-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "5a1c97a5b87fc9fd71f54b5b268bbb18",
"sha256": "e549f54dd768736a60347054a124bf56c77d1df3e35142fa0800f3b096860a19"
},
"downloads": -1,
"filename": "rstobj-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "5a1c97a5b87fc9fd71f54b5b268bbb18",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 39648,
"upload_time": "2019-05-25T03:18:29",
"url": "https://files.pythonhosted.org/packages/1a/0a/273110ee5f23694195e8122fb41acb749418268aa90f010f09681193dbd2/rstobj-0.0.7.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "9ce7ddceb8467113856e0c50d0a987d6",
"sha256": "c53856969d7c03ea6fca8420b3111f61de778002c0c1ff60313650825b524f54"
},
"downloads": -1,
"filename": "rstobj-0.0.7-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ce7ddceb8467113856e0c50d0a987d6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 88095,
"upload_time": "2019-05-25T03:18:27",
"url": "https://files.pythonhosted.org/packages/1b/a4/696ac3be631bea437d3b2b254e69227cfe39a0d0c74da7b8747e3d65a3cc/rstobj-0.0.7-py2.py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "5a1c97a5b87fc9fd71f54b5b268bbb18",
"sha256": "e549f54dd768736a60347054a124bf56c77d1df3e35142fa0800f3b096860a19"
},
"downloads": -1,
"filename": "rstobj-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "5a1c97a5b87fc9fd71f54b5b268bbb18",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 39648,
"upload_time": "2019-05-25T03:18:29",
"url": "https://files.pythonhosted.org/packages/1a/0a/273110ee5f23694195e8122fb41acb749418268aa90f010f09681193dbd2/rstobj-0.0.7.tar.gz"
}
]
}