{ "info": { "author": "Jakub Pie\u0144kowski", "author_email": "jakski@sealcode.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Framework :: Sphinx :: Extension", "Intended Audience :: System Administrators", "License :: OSI Approved :: MIT License", "Topic :: Documentation" ], "description": "sphinxcontrib-yaml\n================================================================================\n\nThis Sphinx autodoc extension documents YAML files from comments. It looks for\ndocumentation comment delimeter(default: ``###``) and adds all further comments\nas reST documentation till it finds another delimeter or non-comment line.\n\nOptions\n--------------------------------------------------------------------------------\n\nOptions available to use in your configuration:\n\n``autoyaml_root``\n Look for YAML files relatively to this directory.\n **DEFAULT**: ..\n\n``autoyaml_doc_delimeter``\n Character(s) which start a documentation comment.\n **DEFAULT**: ###\n\n``autoyaml_comment``\n Comment start character(s).\n **DEFAULT**: #\n\nExample\n--------------------------------------------------------------------------------\n\n.. code-block:: rst\n\n Some title\n ==========\n\n Documenting all YAML files from directory recursively.\n\n .. autoyaml:: some_yml_dir\n\n Documenting single YAML file.\n\n .. autoyaml:: some_yml_file.yml\n\n", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Rayvenden/sphinxcontrib-yaml", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "sphinxcontrib-yaml", "package_url": "https://pypi.org/project/sphinxcontrib-yaml/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-yaml/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/Rayvenden/sphinxcontrib-yaml" }, "release_url": "https://pypi.org/project/sphinxcontrib-yaml/1.0.0/", "requires_dist": null, "requires_python": null, "summary": "Obsolete - use sphinxcontrib-autoyaml instead", "version": "1.0.0" }, "last_serial": 3345643, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "38d43a8fa6d7a4d11f5f7fd2d4e4ac64", "sha256": "e3c2785a9bdb68ff544b3881247258ac66bc7c15a94844afff998ec9ef65efba" }, "downloads": -1, "filename": "sphinxcontrib-yaml-1.0.0.tar.gz", "has_sig": false, "md5_digest": "38d43a8fa6d7a4d11f5f7fd2d4e4ac64", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3114, "upload_time": "2017-03-19T23:25:26", "url": "https://files.pythonhosted.org/packages/96/4e/4748df940f06ebec9f436b71969042974a527118f80ab5f8591b2b93c260/sphinxcontrib-yaml-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "38d43a8fa6d7a4d11f5f7fd2d4e4ac64", "sha256": "e3c2785a9bdb68ff544b3881247258ac66bc7c15a94844afff998ec9ef65efba" }, "downloads": -1, "filename": "sphinxcontrib-yaml-1.0.0.tar.gz", "has_sig": false, "md5_digest": "38d43a8fa6d7a4d11f5f7fd2d4e4ac64", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3114, "upload_time": "2017-03-19T23:25:26", "url": "https://files.pythonhosted.org/packages/96/4e/4748df940f06ebec9f436b71969042974a527118f80ab5f8591b2b93c260/sphinxcontrib-yaml-1.0.0.tar.gz" } ] }