Metadata-Version: 2.1
Name: rstobj
Version: 0.0.3
Summary: Construct RestructuredText markup and directives from Python Code.
Home-page: https://github.com/MacHu-GWU/
Author: Sanhe Hu
Author-email: husanhe@gmail.com
Maintainer: Sanhe Hu
Maintainer-email: husanhe@gmail.com
License: MIT
Download-URL: https://pypi.python.org/pypi/rstobj/0.0.3#downloads
Description: .. image:: https://readthedocs.org/projects/rstobj/badge/?version=latest
            :target: https://rstobj.readthedocs.io/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://travis-ci.org/MacHu-GWU/rstobj-project.svg?branch=master
            :target: https://travis-ci.org/MacHu-GWU/rstobj-project?branch=master
        
        .. image:: https://codecov.io/gh/MacHu-GWU/rstobj-project/branch/master/graph/badge.svg
          :target: https://codecov.io/gh/MacHu-GWU/rstobj-project
        
        .. image:: https://img.shields.io/pypi/v/rstobj.svg
            :target: https://pypi.python.org/pypi/rstobj
        
        .. image:: https://img.shields.io/pypi/l/rstobj.svg
            :target: https://pypi.python.org/pypi/rstobj
        
        .. image:: https://img.shields.io/pypi/pyversions/rstobj.svg
            :target: https://pypi.python.org/pypi/rstobj
        
        .. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
            :target: https://github.com/MacHu-GWU/rstobj-project
        
        ------
        
        
        .. image:: https://img.shields.io/badge/Link-Document-blue.svg
              :target: https://rstobj.readthedocs.io/index.html
        
        .. image:: https://img.shields.io/badge/Link-API-blue.svg
              :target: https://rstobj.readthedocs.io/py-modindex.html
        
        .. image:: https://img.shields.io/badge/Link-Source_Code-blue.svg
              :target: https://rstobj.readthedocs.io/py-modindex.html
        
        .. image:: https://img.shields.io/badge/Link-Install-blue.svg
              :target: `install`_
        
        .. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
              :target: https://github.com/MacHu-GWU/rstobj-project
        
        .. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
              :target: https://github.com/MacHu-GWU/rstobj-project/issues
        
        .. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
              :target: https://github.com/MacHu-GWU/rstobj-project/issues
        
        .. image:: https://img.shields.io/badge/Link-Download-blue.svg
              :target: https://pypi.org/pypi/rstobj#files
        
        
        Welcome to ``rstobj`` Documentation
        ==============================================================================
        
        ``rstobj`` is a library that construct Restructured Text markup or directives from Python Code. ``rstobj`` is based on ``jinja2``.
        
        Example:
        
        .. code-block:: python
        
            import rstobj
        
            ltable = rstobj.directives.ListTable(
                data=[["id", "name"], [1, "Alice"], [2, "Bob"]],
                title="Users",
                header=True,
            )
            rst = ltable.render()
            print(rst)
        
        Output::
        
            .. list-table:: Users
                :header-rows: 1
                :stub-columns: 0
        
                * - id
                  - name
                * - 1
                  - Alice
                * - 2
                  - Bob
        
        I recommend to use this in your jinja2 template, ``outut.rst``::
        
            {{ ltable.render() }}
        
        
        .. _install:
        
        Install
        ------------------------------------------------------------------------------
        
        ``rstobj`` is released on PyPI, so all you need is:
        
        .. code-block:: console
        
            $ pip install rstobj
        
        To upgrade to latest version:
        
        .. code-block:: console
        
            $ pip install --upgrade rstobj
Platform: Windows
Platform: MacOS
Platform: Unix
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Provides-Extra: docs
Provides-Extra: tests
