{ "info": { "author": "Hiroyuki Ohsaki", "author_email": "ohsaki@lsnl.jp", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# rstparse Package\n\nrstparse - expand and analyze RST (reStructureText) documents with auto*-directives\n\n# DESCRIPTION\n\nThis manual page documents **rstparse**, a Python module for parsing RST\n(reStructureText) documents. \n\nMany documents of Python and its standard libraries, as well as a vast number\nof third party modules are written as RST (reStructureText) markup documents.\nRST documents are easier to handle since, similarly to other markup document\nformats such as Markdown, it is mostly a plain text file with several\nadditional notations.\n\nSince RST documents are plain text files, you can easily browse those\ndocuments using your favorite tools like pagers (e.g., `more`, `less`, and\n`lv`) and also you can search for topics that you are interested in using\ncommon tools such as `grep`.\n\nHowever, a significant portion of RST files use *auto* directives (e.g.,\nautosummary, automodule, autoclass, and autofunction), which ask the RST\nparser to include the contents from somewhere outside the RST document. For\ninstance, if an RST file contains a line,\n\n```\n.. autosummary: good_func\n```\n\nthe description of `good_func` is not contained in this file. `autosummary`\nmeans the description must be inserted here. It is an RST parser's\nresponsibility to identify where the description of `good_func` is stored.\n**rstparse** module parses an RST file and expands all auto*-directives.\n\n# EXAMPLE\n\n```python\nimport rstparse\n\nfile = 'foo.rst'\nrst = rstparse.Parser()\nwith open(file) as f:\n rst.read(f)\nrst.parse()\nfor line in rst.lines:\n\tprint(line)\n```\n\n# INSTALLATION\n\n```python\npip3 install rstparser\n```\n\n# AVAILABILITY\n\nThe latest version of **rstparser** module is available at PyPI\n(https://pypi.org/project/rstparser/) .\n\n# SEE ALSO\n\n- reStructuredText Markup Specification\n\n https://docutils.readthedocs.io/en/sphinx-docs/ref/rst/restructuredtext.html\n\n- reStructuredText Directives\n\n https://docutils.readthedocs.io/en/sphinx-docs/ref/rst/directives.html\n\n# AUTHOR\n\nHiroyuki Ohsaki \n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/h-ohsaki/rstparse", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "rstparse", "package_url": "https://pypi.org/project/rstparse/", "platform": "", "project_url": "https://pypi.org/project/rstparse/", "project_urls": { "Homepage": "https://github.com/h-ohsaki/rstparse" }, "release_url": "https://pypi.org/project/rstparse/1.0/", "requires_dist": null, "requires_python": "", "summary": "expand and analyze RST (reStructureText) documents with auto*-directives", "version": "1.0" }, "last_serial": 5519136, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "34998ec4e9d17e4596499d4dc1252f7d", "sha256": "991c54d7be03a3441b8f48ff1f883d46e91c6c0c5c4772dd11ad54899e144e01" }, "downloads": -1, "filename": "rstparse-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "34998ec4e9d17e4596499d4dc1252f7d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 16838, "upload_time": "2019-07-11T16:44:24", "url": "https://files.pythonhosted.org/packages/c3/a3/6e5c1c90539b37bc1957c9730d9d024680dec022840210e9723ed0390be1/rstparse-1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "539331de5348106f597e3b27d07d2627", "sha256": "3c22641e5cddffeae3375b83ca1f3f864dfdffac54d66a84e6437b3ffeea2097" }, "downloads": -1, "filename": "rstparse-1.0.tar.gz", "has_sig": false, "md5_digest": "539331de5348106f597e3b27d07d2627", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4274, "upload_time": "2019-07-11T16:44:27", "url": "https://files.pythonhosted.org/packages/15/46/a369a55b74ee4ccd00cfb14ff43927d76b58d0700c07e576df8ff91d7e1c/rstparse-1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "34998ec4e9d17e4596499d4dc1252f7d", "sha256": "991c54d7be03a3441b8f48ff1f883d46e91c6c0c5c4772dd11ad54899e144e01" }, "downloads": -1, "filename": "rstparse-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "34998ec4e9d17e4596499d4dc1252f7d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 16838, "upload_time": "2019-07-11T16:44:24", "url": "https://files.pythonhosted.org/packages/c3/a3/6e5c1c90539b37bc1957c9730d9d024680dec022840210e9723ed0390be1/rstparse-1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "539331de5348106f597e3b27d07d2627", "sha256": "3c22641e5cddffeae3375b83ca1f3f864dfdffac54d66a84e6437b3ffeea2097" }, "downloads": -1, "filename": "rstparse-1.0.tar.gz", "has_sig": false, "md5_digest": "539331de5348106f597e3b27d07d2627", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4274, "upload_time": "2019-07-11T16:44:27", "url": "https://files.pythonhosted.org/packages/15/46/a369a55b74ee4ccd00cfb14ff43927d76b58d0700c07e576df8ff91d7e1c/rstparse-1.0.tar.gz" } ] }