{ "info": { "author": "Jam Risser", "author_email": "jam@codejam.ninja", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Utilities" ], "description": "sphinx-markdown-parser\n======================\n\nA ``docutils``-compatibility bridge to MarkdownParser and CommonMark.\n\nThis allows you to write markdown inside of docutils & sphinx projects.\n\nThis was built due to limitations of the existing markdown parsers\nsupported by sphinx, specifically recommonmark. Features such as support\nfor tables have been added to this extension.\n\nContents\n--------\n\n- `API Reference `__\n- `AutoStructify Component `__\n\nGetting Started\n---------------\n\nTo use ``sphinx-markdown-parser`` inside of Sphinx only takes 2 steps.\nFirst you install it:\n\n::\n\n pip install sphinx-markdown-parser\n\nThen add this to your Sphinx conf.py:\n\n::\n\n # for MarkdownParser\n from sphinx_markdown_parser.parser import MarkdownParser\n\n def setup(app):\n app.add_source_suffix('.md', 'markdown')\n app.add_source_parser(MarkdownParser)\n app.add_config_value('markdown_parser_config', {\n 'auto_toc_tree_section': 'Content',\n 'enable_auto_doc_ref': True,\n 'enable_auto_toc_tree': True,\n 'enable_eval_rst': True,\n 'enable_inline_math': True,\n 'enable_math': True,\n }, True)\n\n # for CommonMarkParser\n from recommonmark.parser import CommonMarkParser\n\n def setup(app):\n app.add_source_suffix('.md', 'markdown')\n app.add_source_parser(CommonMarkParser)\n app.add_config_value('markdown_parser_config', {\n 'auto_toc_tree_section': 'Content',\n 'enable_auto_doc_ref': True,\n 'enable_auto_toc_tree': True,\n 'enable_eval_rst': True,\n 'enable_inline_math': True,\n 'enable_math': True,\n }, True)\n\nThis allows you to write both ``.md`` and ``.rst`` files inside of the\nsame project.\n\nLinks\n~~~~~\n\nFor all links in commonmark that aren\u2019t explicit URLs, they are treated\nas cross references with the\n```:any:`` `__\nrole. This allows referencing a lot of things including files, labels,\nand even objects in the loaded domain.\n\nAutoStructify\n~~~~~~~~~~~~~\n\nAutoStructify makes it possible to write your documentation in Markdown,\nand automatically convert this into rST at build time. See `the\nAutoStructify\nDocumentation `__\nfor more information about configuration and usage.\n\nTo use the advanced markdown to rst transformations you must add\n``AutoStructify`` to your Sphinx conf.py.\n\n.. code:: python\n\n # At top on conf.py (with other import statements)\n import recommonmark\n from recommonmark.transform import AutoStructify\n\n # At the bottom of conf.py\n def setup(app):\n app.add_config_value('markdown_parser_config', {\n 'url_resolver': lambda url: github_doc_root + url,\n 'auto_toc_tree_section': 'Contents',\n }, True)\n app.add_transform(AutoStructify)\n\nSee https://github.com/rtfd/recommonmark/blob/master/docs/conf.py for a\nfull example.\n\nAutoStructify comes with the following options. See\nhttp://recommonmark.readthedocs.org/en/latest/auto_structify.html for\nmore information about the specific features.\n\n- **enable_auto_toc_tree**: enable the Auto Toc Tree feature.\n- **auto_toc_tree_section**: when True, Auto Toc Tree will only be\n enabled on section that matches the title.\n- **enable_auto_doc_ref**: enable the Auto Doc Ref feature.\n **Deprecated**\n- **enable_math**: enable the Math Formula feature.\n- **enable_inline_math**: enable the Inline Math feature.\n- **enable_eval_rst**: enable the evaluate embedded reStructuredText\n feature.\n- **url_resolver**: a function that maps a existing relative position\n in the document to a http link\n\nDevelopment\n-----------\n\nYou can run the tests by running ``tox`` in the top-level of the\nproject.\n\nWe are working to expand test coverage, but this will at least test\nbasic Python 2 and 3 compatability.\n\nWhy a bridge?\n-------------\n\nMany python tools (mostly for documentation creation) rely on\n``docutils``. But\n`docutils `__\nonly supports a ReStructuredText syntax.\n\nFor instance `this\nissue `__\nand `this StackOverflow\nquestion `__\nshow that there is an interest in allowing ``docutils`` to use markdown\nas an alternative syntax.\n\nWhy another bridge to docutils?\n-------------------------------\n\nrecommonmark uses the `python\nimplementation `__ of\n`CommonMark `__ while\n`remarkdown `__ implements a\nstand-alone parser leveraging\n`parsley `__.\n\nBoth output a ```docutils`` document\ntree `__ and\nprovide scripts that leverage ``docutils`` for generation of different\ntypes of documents.\n\nAcknowledgement\n---------------\n\nrecommonmark is mainly derived from\n`remarkdown `__ by Steve Genoud\nand leverages the python CommonMark implementation.\n\nIt was originally created by `Luca\nBarbato `__, and is now maintained in the\nRead the Docs (rtfd) GitHub organization.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/codejamninja/sphinx-markdown-parser", "keywords": "sphinx docs documentation markdown", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sphinx-markdown-parser", "package_url": "https://pypi.org/project/sphinx-markdown-parser/", "platform": "", "project_url": "https://pypi.org/project/sphinx-markdown-parser/", "project_urls": { "Homepage": "https://github.com/codejamninja/sphinx-markdown-parser" }, "release_url": "https://pypi.org/project/sphinx-markdown-parser/0.1.7/", "requires_dist": [ "Markdown (>=3.1.1)", "commonmark (>=0.9.0)", "pydash (>=4.7.5)", "pyyaml (>=5.1.2)", "sphinx (>=2.2.0)", "unify (>=0.5)", "yapf (>=0.28.0)" ], "requires_python": "", "summary": "A docutils-compatibility bridge to markdown, enabling you to write markdown with support for tables inside of docutils & sphinx projects.", "version": "0.1.7" }, "last_serial": 5807913, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "d93efcb1721271d7055d9ec6e9301308", "sha256": "37a552512ff8e7e56a2e6d75497c4a08618e09bf3888dc5020cd1faf4178b214" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d93efcb1721271d7055d9ec6e9301308", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13781, "upload_time": "2019-02-13T14:36:31", "url": "https://files.pythonhosted.org/packages/35/f3/3466f4367edcc147b637532e7f7f2ea5707de80d7ac609d00112e1299adf/sphinx_markdown_parser-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "41bff8cde6aadadda81325a21adf6cb3", "sha256": "7bafaad61564a6397a45208b2421802f7a9f0c083929161c181cfd8c4496ebf2" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.0.tar.gz", "has_sig": false, "md5_digest": "41bff8cde6aadadda81325a21adf6cb3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 25934, "upload_time": "2019-02-13T14:36:34", "url": "https://files.pythonhosted.org/packages/7d/db/f96cd206d7db9306e03fd3a82a54ce860e192e8b0238586e16a8f6e3ebf0/sphinx_markdown_parser-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "fd7aaa68fbd6a051d8e768285f677833", "sha256": "361379385207cafd7c24e47991f02cf666bf482d2eeb134f12b8beaa4d6899aa" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "fd7aaa68fbd6a051d8e768285f677833", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13786, "upload_time": "2019-06-27T13:09:22", "url": "https://files.pythonhosted.org/packages/bc/af/a8f7825df4d7fa65f4ac8ea85a02782e823cb807e6763729bc8e61f98ddf/sphinx_markdown_parser-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "35de7db473872fab8f5831896779b4df", "sha256": "91e35982964f6e1cce9ae3f03af359876a1d691254113e874494ad81d53f9963" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.1.tar.gz", "has_sig": false, "md5_digest": "35de7db473872fab8f5831896779b4df", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26032, "upload_time": "2019-06-27T13:09:24", "url": "https://files.pythonhosted.org/packages/90/71/b469476e6fd751458a4d0be7288b92d118cee028e2154da8cd48ff751d42/sphinx_markdown_parser-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "d10aa1d4b1fe20b0b884788f74cea4af", "sha256": "2c2eab0f08c5884d0c78270e3d673b08900dc7e497233264bf469cc4a98b5d26" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d10aa1d4b1fe20b0b884788f74cea4af", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16619, "upload_time": "2019-09-08T22:17:17", "url": "https://files.pythonhosted.org/packages/8d/ba/0c9055e6245f50d1e7a72bd873506a91043488954c1383dd0d3bc7349bbf/sphinx_markdown_parser-0.1.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "840ce5503147ea6e442607dc716bb8de", "sha256": "16c4f9c32940512a864716431b8c4b14e2b7321592a9d02beadfbf5214a2504e" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.2.tar.gz", "has_sig": false, "md5_digest": "840ce5503147ea6e442607dc716bb8de", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30029, "upload_time": "2019-09-08T22:17:19", "url": "https://files.pythonhosted.org/packages/12/f1/b5308ace7d6cc4ad628de7c8c4c6358d9799a90cc31d062c9aaebd322443/sphinx_markdown_parser-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "9e4ce1471c54b122e6192224b547ff21", "sha256": "a143a34197f25160eb2eff60c585082fa2a046117baacb93d40d6095d495923d" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9e4ce1471c54b122e6192224b547ff21", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16630, "upload_time": "2019-09-08T23:41:16", "url": "https://files.pythonhosted.org/packages/6a/3a/812e423bd920887df9ea5e4d49ab18c35408d42645260c8f7e0b85a62e5b/sphinx_markdown_parser-0.1.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "65ab0b9663615419c97860f5418c710f", "sha256": "d3ce737bf22ee446e73ef406c9cce882518d68266046ed2e293fd2c110c9a43d" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.3.tar.gz", "has_sig": false, "md5_digest": "65ab0b9663615419c97860f5418c710f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30041, "upload_time": "2019-09-08T23:41:17", "url": "https://files.pythonhosted.org/packages/be/91/1c0faa296d20f2f4426487ce4862c1fa814b3c3f1a135f7718cca580ece5/sphinx_markdown_parser-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "25001bd51878be77cffbc8b738b291f5", "sha256": "c9f11dc15df24041c7e4f2d74df6b9d08b292d433c733fa5eb85c8f12c2d3271" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "25001bd51878be77cffbc8b738b291f5", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16679, "upload_time": "2019-09-08T23:48:22", "url": "https://files.pythonhosted.org/packages/8e/81/cdbdaa1886bf8a0ac599520fba41b3bd4001e228984e2bf8dbef685053d9/sphinx_markdown_parser-0.1.4-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "57cb4c16ff992ecfc12da23eb57e77ef", "sha256": "d294da50501808e1545eda1996b439f4739b21f672846993c0d3c353d0d0fdf9" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.4.tar.gz", "has_sig": false, "md5_digest": "57cb4c16ff992ecfc12da23eb57e77ef", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30223, "upload_time": "2019-09-08T23:48:24", "url": "https://files.pythonhosted.org/packages/93/f4/81a2c0bdef71cd4e15bf8675039cea7a695aa68460740ba13ae3ac777f48/sphinx_markdown_parser-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "318e20219feb7e344461d1c24f2d98d9", "sha256": "304b008cada99641fdc8689499bf344c92c7c02798d1446eea9771b0aeb1e3de" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "318e20219feb7e344461d1c24f2d98d9", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16705, "upload_time": "2019-09-09T22:18:29", "url": "https://files.pythonhosted.org/packages/fd/1a/45626f1a80f2e74ffb1d9c134177c7b74ee7ecfec4df154ec3648e00cc6c/sphinx_markdown_parser-0.1.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f579cf1840f10bb1b4e1415209875ef7", "sha256": "ef06390b401372075799ff525e5d91edd6b550f8251dd593e50d192d8e058cab" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.5.tar.gz", "has_sig": false, "md5_digest": "f579cf1840f10bb1b4e1415209875ef7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30263, "upload_time": "2019-09-09T22:18:31", "url": "https://files.pythonhosted.org/packages/e0/fd/dda0034bd9d85741676bfba9d32e8feff09d67e20b74bc8c3dcbf2446fee/sphinx_markdown_parser-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "e5c9c7092861551278a6a04e25a7a305", "sha256": "8bf16c3079d36baefa363d13908f8b8f31536837b73ade11732782321c2ccb5d" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.6-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e5c9c7092861551278a6a04e25a7a305", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16708, "upload_time": "2019-09-10T09:19:20", "url": "https://files.pythonhosted.org/packages/fb/08/bc7d6b9e4d14c4b9ead1d81ed1151e751108963b18b55b46c1e3f8dc39d6/sphinx_markdown_parser-0.1.6-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ed7d9e63eedb55e3300e0ffec181b48b", "sha256": "79e8d7e905c2a88c637819b8b06886fa8e8bcc8d607368e3b460aad146ed545e" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.6.tar.gz", "has_sig": false, "md5_digest": "ed7d9e63eedb55e3300e0ffec181b48b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30278, "upload_time": "2019-09-10T09:19:22", "url": "https://files.pythonhosted.org/packages/05/cd/76b0be036a983f8cdaea8009a482a85de011e72b83d77cfebeb4c0511849/sphinx_markdown_parser-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "4ae10c05214234afa43a6fcec775c63e", "sha256": "8af5aacd92c4ec3855b17648b741f0c251320637a95534114f65363228986bee" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4ae10c05214234afa43a6fcec775c63e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16699, "upload_time": "2019-09-10T09:25:43", "url": "https://files.pythonhosted.org/packages/e8/1f/dae7d8fe7dc25ec56803dfdfdd5fab3af9aa36d785d3b205d18d16dfbe22/sphinx_markdown_parser-0.1.7-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ff2874df72e76ec43c93d86fd12069cc", "sha256": "2a82d8cc2b6c9390561c0e7e9285d6f5498f253735bc76fd67ef323478effb9d" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.7.tar.gz", "has_sig": false, "md5_digest": "ff2874df72e76ec43c93d86fd12069cc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30260, "upload_time": "2019-09-10T09:25:45", "url": "https://files.pythonhosted.org/packages/48/04/4b871009c4568364e353576b473d6d05e728171173d426935c62724ed618/sphinx_markdown_parser-0.1.7.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4ae10c05214234afa43a6fcec775c63e", "sha256": "8af5aacd92c4ec3855b17648b741f0c251320637a95534114f65363228986bee" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4ae10c05214234afa43a6fcec775c63e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16699, "upload_time": "2019-09-10T09:25:43", "url": "https://files.pythonhosted.org/packages/e8/1f/dae7d8fe7dc25ec56803dfdfdd5fab3af9aa36d785d3b205d18d16dfbe22/sphinx_markdown_parser-0.1.7-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ff2874df72e76ec43c93d86fd12069cc", "sha256": "2a82d8cc2b6c9390561c0e7e9285d6f5498f253735bc76fd67ef323478effb9d" }, "downloads": -1, "filename": "sphinx_markdown_parser-0.1.7.tar.gz", "has_sig": false, "md5_digest": "ff2874df72e76ec43c93d86fd12069cc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30260, "upload_time": "2019-09-10T09:25:45", "url": "https://files.pythonhosted.org/packages/48/04/4b871009c4568364e353576b473d6d05e728171173d426935c62724ed618/sphinx_markdown_parser-0.1.7.tar.gz" } ] }