{
    "info": {
        "author": "Uli Fouquet, parts by Georg Brandl and Lea Wiemann",
        "author_email": "uli@gnufix.de",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Environment :: Console",
            "Intended Audience :: Developers",
            "Intended Audience :: End Users/Desktop",
            "Intended Audience :: Other Audience",
            "Intended Audience :: System Administrators",
            "License :: OSI Approved :: BSD License",
            "License :: OSI Approved :: GNU General Public License (GPL)",
            "License :: Public Domain",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Topic :: Documentation",
            "Topic :: Software Development :: Documentation",
            "Topic :: Text Processing"
        ],
        "description": "ulif.rest\r\n*********\r\n\r\nis a package that provides some ReStructuredText extensions. The\r\nextensions collected in this package provide support for some of the\r\nmarkup used in RestructuredText documents of the stock Python\r\ndocumentation toolchain. Also a pygments directive (written by Georg\r\nBrandl) is included, which enables syntax highlighting of code\r\nfragments in reStructuredText docs with the ``pygments`` package.\r\n\r\nSee `README.txt` in the ``src/ulif/rest`` directory for API\r\ndocumentation.\r\n\r\nNote, that this is alphaware! Do not use it in productive\r\nenvironments!\r\n\r\nPrerequisites\r\n=============\r\n\r\nYou need:\r\n\r\n- Python 2.4. Rumors are, that also Python 2.5 will do.\r\n\r\n- `setuptools`, available from \r\n  http://peak.telecommunity.com/DevCenter/setuptools\r\n\r\nOther needed packages will be downloaded during\r\ninstallation. Therefore you need an internet connection during\r\ninstallation. \r\n\r\n\r\nInstallation\r\n============\r\n\r\nNormally, this package should from other packages, that use it as a\r\nhelper lib. Thus, you do not have to care for installation. If you\r\nwant to integrate `ulif.rest` in your project, just declare\r\n`ulif.rest` as a required package in your ``setup.py``.\r\n\r\nwith `buildout`\r\n---------------\r\n\r\nYou can install this package with `buildout` as follows:\r\n\r\n\r\nFrom the root of the package run::\r\n\r\n     $ python2.4 bootstrap/bootstrap.py\r\n\r\nThis will download and install everything to run `buildout` in the\r\nnext step. Afterwards an executable script `buildout` should be\r\navailable in the freshly created `bin/` directory.\r\n\r\nNext, fetch all needed packages, install them and create provided\r\nscripts::\r\n\r\n     $ bin/buildout\r\n\r\nThis should create a `test` script in `bin/`.\r\n\r\nRunning::\r\n\r\n     $ bin/test\r\n\r\nyou can test the installed package.\r\n\r\n\r\nwith `easy_install`\r\n-------------------\r\n\r\nRun as a superuser::\r\n\r\n     # easy_install ulif.rest\r\n\r\nThis should make the package available in your system Python.\r\n\r\n\r\nUsage\r\n=====\r\n\r\nSee `README.txt` and other .txt files in the ``src/ulif/rest/`` directory\r\nfor API documentation.\r\n\r\n\r\n\r\nDetailed Documentation\r\n**********************\r\n\r\n\r\nRestructuredText (ReST) Extensions\r\n==================================\r\n\r\nWhat is this?\r\n-------------\r\n\r\nThe extensions collected in this package provide support for some of\r\nthe markup used in RestructuredText documents of the stock Python\r\ndocumentation toolchain.\r\n\r\nRestructuredText is a document markup language with special human\r\nreadable markup, that is widely spread in the Python\r\nworld. RestructuredText documents are a bit like HTML but better\r\nreadable. The text you are reading, for example, is written as ReST.\r\n\r\nSee\r\n\r\n\thttp://docutils.sourceforge.net/rst.html\r\n\r\nto learn more about ReST (and ``docutils``).\r\n\r\nNormally, ReST documents can be processed with tools of the Python\r\npackage ``docutils``. The ``docutils`` include so-called readers,\r\nparsers, writers and publishers for reading ReST documents and writing\r\nvarious output formats like HTML, XML or LaTeX.\r\n\r\nSince Python switched from LaTeX to ReST documentation with the 2.6\r\nversion, some special markup was introduced like ``function``,\r\n``seealso`` or ``versionchanged``, that helps to describe a\r\nprogramming API more precisely. These additional 'tags', however,\r\nneeded specialized readers, parsers, writers and publishers to be\r\nunderstood. The normal docutils tools did not understand the new roles\r\nand directives.\r\n\r\nThis package makes it possible to use the standard ``docutils``\r\nparsers and writers with the additional roles and directives listed\r\nbelow.\r\n\r\n\r\nPrerequisites and requirements\r\n------------------------------\r\n\r\n- ``docutils`` -- version 0.4 is recommended. \r\n\r\n  It can be retrieved from http://docutils.sourceforge.net/.\r\n\r\n- ``Pygments`` -- a syntax highlighter.\r\n\r\n  It can be retrieved from http://pygments.org/. This is only needed,\r\n  if you want syntax highlighting of code fragments in your ReST\r\n  documents.\r\n\r\n  Because there is currently only support for HTML with pygments, you\r\n  won't use it for other output formats. In this case you don't need\r\n  pygments. \r\n\r\nBoth packages can also retrieved via cheeseshop and ``easy_install``.\r\n\r\n\r\nActivate support for the additional set of roles/directives\r\n-----------------------------------------------------------\r\n\r\nJust import the modules in this package::\r\n\r\n  from ulif.rest import directives_plain\r\n  from ulif.rest import roles_plain\r\n  from ulif.rest import pygments_directive # for syntax-highlighting support\r\n\r\nThat's it. The modules define and register the new roles and\r\ndirectives with the ``docutils`` automatically. You don't have to call\r\na special function.\r\n\r\n\r\nRunning the tests\r\n-----------------\r\n\r\nCall ``tests/alltests.py`` with your favourite Python interpreter::\r\n\r\n  $ python tests/alltests.py\r\n\r\nNote, that ``docutils`` must be available in your PYTHON_PATH.\r\n\r\nIf you installed the source version with buildout (not an egg), you\r\ncan generate a ``buildout`` executable in the bin/ directory of the\r\nsource root and run::\r\n\r\n  $ bin/test\r\n\r\n\r\nWhich roles and directives are supported:\r\n-----------------------------------------\r\n\r\n``pygments_directive`` adds the following new directives:\r\n\r\n- `sourcecode` -- a directive to highlight syntax of the following\r\n                  code block. It takes one parameter, the language,\r\n                  and currently only supports HTML output.\r\n\r\n                  Example::\r\n\r\n                    .. sourcecode:: python\r\n\r\n                       class Cave(object):\r\n                            pass\r\n\r\n                    This will render the class definition with\r\n                    colours.\r\n\r\n\t\t    An additional optional parameter is ``linenos``,\r\n\t\t    which adds linenumbers to the code::\r\n\r\n\t\t    .. sourcecode:: python\r\n                       :linenos:\r\n\r\n                       class NumberedCave(object):\r\n                           pass\r\n\r\n\t            will render the code block with line numbering.\r\n\r\n                    See the source for further options.\r\n\t\t    \r\n\r\n- `code-block` -- an alias for `sourcecode`.\r\n\r\n\r\n``directives_plain`` adds the follwing new directives:\r\n\r\n- `function` -- a directive to describe functions with their\r\n                signature.\r\n\r\n- `data` -- ???\r\n\r\n- `class` -- a directive to define a Python class.\r\n\r\n- `method` -- a directive to describe the method of a Python class.\r\n\r\n- `attribute` -- a directive to describe an attribute of a Python\r\n                 class.\r\n\r\n- `exception` -- a directive to describe an exception.\r\n\r\n- `cmdoption` -- a directive to describe a command option.\r\n\r\n- `envvar` -- a directive to describe an environment variable.\r\n\r\n- `describe` -- a directive to describe something.\r\n\r\n\r\n- `seealso` -- a directive to add a 'See also' subsection. It requires\r\n               some 'body'-text.\r\n\r\n- `deprecated` -- a directive to add a deprecation warning. It also\r\n                  requires some explanatory body text and a version\r\n                  number.\r\n\r\n- `versionadded` -- a directive to add a note that tells, in which\r\n                    version the surrounding thing was added to the\r\n                    API.\r\n          \r\n                    Requires a version number and an explanatory text.\r\n\r\n                    Example::\r\n\r\n                      .. versionadded:: 0.11\r\n\r\n                         Added for convenience reasons.\r\n\r\n- `versionchanged` -- a directive to add a note that tell, in which\r\n                      version a signature or something else changed\r\n                      and why.\r\n\r\n                      Example::\r\n\r\n                        .. versionchanged:: 0.11\r\n\r\n                          Added cave parameter, because every caveman\r\n                          needs a cave.\r\n\r\n- `toctree` -- a directive that requests to generate a\r\n               table-of-contents tree of files, given in the body part\r\n               of the directive. The so-called toc-tree will not\r\n               be generated by standard writers, because it needs at\r\n               least two parsing passes (one to collect all\r\n               references, another pass to generate the reference\r\n               targets).\r\n\r\n\t       If you insert a toctree directive in a document, this\r\n\t       will not block parsing of the document any more, but \r\n\t       the toctree will be 'invisible' in rendered documents.\r\n\r\n\t       The toctree directive supports a ``maxdepth``\r\n\t       parameter, a number, that tells, to which depth a\r\n\t       toctree should be generated (default: no limit).\r\n\r\n\t       Example::\r\n\r\n                 .. toctree::\r\n                    :maxdepth: 2\r\n\r\n                    chapter1.rst\r\n                    chapter2.rst\r\n                    another_file.rst\r\n\r\n\t         This should render a table of contents with the\r\n\t         headings of the three given files. Only headers of\r\n\t         level 1 and 2 will be included in the toctree.\r\n\r\n``roles_plain`` adds the following new roles:\r\n\r\n- `data`\r\n\r\n- `exc`\r\n\r\n- `func`\r\n\r\n- `class`\r\n\r\n- `const`\r\n\r\n- `attr`\r\n\r\n- `meth`\r\n\r\n- `cfunc`\r\n\r\n- `cdata`\r\n\r\n- `ctype`\r\n\r\n- `cmacro`\r\n\r\n- `mod`\r\n\r\n- `keyword`\r\n\r\n- `ref`\r\n\r\n- `token`\r\n\r\n- `term`\r\n\r\n- `file`\r\n\r\n- `samp`\r\n\r\nEvery role can be used like this :<rolename>:`<text>`. For example::\r\n\r\n   :func:`my_function` \r\n\r\nwill output the text ``my_function``, rendered in\r\na different way than normal text. The exact kind of rendering depends\r\non the writer and translator that is used. In usual HTML writers it\r\nwill be rendered with roman fonts.\r\n\r\nThe same applies to all the other roles.\r\n\r\n\r\n\r\nCHANGES\r\n*******\r\n\r\n0.1.0 (2008-02-24)\r\n==================\r\n\r\nFeature changes\r\n---------------\r\n\r\n- Initial Release\r\n\r\n\r\nDownload\r\n********",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://pypi.python.org/pypi/ulif.rest",
        "keywords": "docutils sphinx documentation rest restructuredtext pygments",
        "license": "public domain, BSD, GPL",
        "maintainer": "",
        "maintainer_email": "",
        "name": "ulif.rest",
        "package_url": "https://pypi.org/project/ulif.rest/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/ulif.rest/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "http://pypi.python.org/pypi/ulif.rest"
        },
        "release_url": "https://pypi.org/project/ulif.rest/0.1.0/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "ReStructuredText extensions.",
        "version": "0.1.0"
    },
    "last_serial": 801202,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "85b3b8323a9f235d1cea36f784066c11",
                    "sha256": "bd1db5019ead078d4885adbd5f2b77c1a9e6a8a56448ad87f088269325ed50b5"
                },
                "downloads": -1,
                "filename": "ulif.rest-0.1.0-py2.4.egg",
                "has_sig": false,
                "md5_digest": "85b3b8323a9f235d1cea36f784066c11",
                "packagetype": "bdist_egg",
                "python_version": "2.4",
                "requires_python": null,
                "size": 80940,
                "upload_time": "2008-02-24T14:48:43",
                "url": "https://files.pythonhosted.org/packages/50/50/8a1cdf9bf7933f466a2a87b0cce9bfc6d721cebd032c48617dbb42f2e06d/ulif.rest-0.1.0-py2.4.egg"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "c9da82f1d78df0318a3298b1dd9d9eb8",
                    "sha256": "113de9a16e6a599c1e4f96758dec70cf5fce17104cee19ea045daf52afbc7886"
                },
                "downloads": -1,
                "filename": "ulif.rest-0.1.0-py2.5.egg",
                "has_sig": false,
                "md5_digest": "c9da82f1d78df0318a3298b1dd9d9eb8",
                "packagetype": "bdist_egg",
                "python_version": "2.5",
                "requires_python": null,
                "size": 80257,
                "upload_time": "2008-02-24T14:50:45",
                "url": "https://files.pythonhosted.org/packages/a0/92/96358729af5901d5f4dd58f0dd7e4d6a0e5112848471ed1fdbabbfb6757a/ulif.rest-0.1.0-py2.5.egg"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "e5e1909a7ddc851f51b84423f791fb19",
                    "sha256": "c244e069425e2e2bb9b207491a19f965cb6ec2b3a1004f6013c65e0eb6340086"
                },
                "downloads": -1,
                "filename": "ulif.rest-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "e5e1909a7ddc851f51b84423f791fb19",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 38603,
                "upload_time": "2008-02-24T14:48:40",
                "url": "https://files.pythonhosted.org/packages/ef/09/d8ec425a1ec6eaaa3c58fc0849eb1b0cebc22be214ae677640d5bc51e853/ulif.rest-0.1.0.tar.gz"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "d21e75812dad6c658c1b06a26d4a2de6",
                    "sha256": "31a532dc3e3b29c7971d97862e48ff80158a4d93c7f7f987f3c12759fcc1ebf8"
                },
                "downloads": -1,
                "filename": "ulif.rest-0.1.0.zip",
                "has_sig": false,
                "md5_digest": "d21e75812dad6c658c1b06a26d4a2de6",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 52984,
                "upload_time": "2008-02-24T14:48:37",
                "url": "https://files.pythonhosted.org/packages/d9/87/63469396225a7ee5f34c02406825f59b9a620280a94fb4a472fdbbda35e1/ulif.rest-0.1.0.zip"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "85b3b8323a9f235d1cea36f784066c11",
                "sha256": "bd1db5019ead078d4885adbd5f2b77c1a9e6a8a56448ad87f088269325ed50b5"
            },
            "downloads": -1,
            "filename": "ulif.rest-0.1.0-py2.4.egg",
            "has_sig": false,
            "md5_digest": "85b3b8323a9f235d1cea36f784066c11",
            "packagetype": "bdist_egg",
            "python_version": "2.4",
            "requires_python": null,
            "size": 80940,
            "upload_time": "2008-02-24T14:48:43",
            "url": "https://files.pythonhosted.org/packages/50/50/8a1cdf9bf7933f466a2a87b0cce9bfc6d721cebd032c48617dbb42f2e06d/ulif.rest-0.1.0-py2.4.egg"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "c9da82f1d78df0318a3298b1dd9d9eb8",
                "sha256": "113de9a16e6a599c1e4f96758dec70cf5fce17104cee19ea045daf52afbc7886"
            },
            "downloads": -1,
            "filename": "ulif.rest-0.1.0-py2.5.egg",
            "has_sig": false,
            "md5_digest": "c9da82f1d78df0318a3298b1dd9d9eb8",
            "packagetype": "bdist_egg",
            "python_version": "2.5",
            "requires_python": null,
            "size": 80257,
            "upload_time": "2008-02-24T14:50:45",
            "url": "https://files.pythonhosted.org/packages/a0/92/96358729af5901d5f4dd58f0dd7e4d6a0e5112848471ed1fdbabbfb6757a/ulif.rest-0.1.0-py2.5.egg"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "e5e1909a7ddc851f51b84423f791fb19",
                "sha256": "c244e069425e2e2bb9b207491a19f965cb6ec2b3a1004f6013c65e0eb6340086"
            },
            "downloads": -1,
            "filename": "ulif.rest-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e5e1909a7ddc851f51b84423f791fb19",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 38603,
            "upload_time": "2008-02-24T14:48:40",
            "url": "https://files.pythonhosted.org/packages/ef/09/d8ec425a1ec6eaaa3c58fc0849eb1b0cebc22be214ae677640d5bc51e853/ulif.rest-0.1.0.tar.gz"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "d21e75812dad6c658c1b06a26d4a2de6",
                "sha256": "31a532dc3e3b29c7971d97862e48ff80158a4d93c7f7f987f3c12759fcc1ebf8"
            },
            "downloads": -1,
            "filename": "ulif.rest-0.1.0.zip",
            "has_sig": false,
            "md5_digest": "d21e75812dad6c658c1b06a26d4a2de6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 52984,
            "upload_time": "2008-02-24T14:48:37",
            "url": "https://files.pythonhosted.org/packages/d9/87/63469396225a7ee5f34c02406825f59b9a620280a94fb4a472fdbbda35e1/ulif.rest-0.1.0.zip"
        }
    ]
}