{ "info": { "author": "Avery Pennarun", "author_email": "apenwarr@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# File exclude plugin for mkdocs\n\n`mkdocs-exclude` is a\n[mkdocs plugin](http://www.mkdocs.org/user-guide/plugins/) that allows you\nto exclude files from your input using unix-style wildcards (globs) or\nregular expressions (regexes).\n\nThis implements what people were asking for in some mkdocs bugs, such as\n and\n.\n\n\n## Quick start\n\n1. Install the module using pip: `pip3 install mkdocs-exclude`\n\n2. In your project, add a plugin configuration to `mkdocs.yml`:\n\n ```yaml\n plugins:\n - exclude:\n glob:\n - exclude/this/path/*\n - \"*.tmp\"\n - \"*.pdf\"\n - \"*.gz\"\n regex:\n - '.*\\.(tmp|bin|tar)$'\n ```\n\nYou can provide zero or more patterns of each type. (If you don't provide\nany patterns, then nothing will happen!)\n\nNote! Because of peculiarity of yaml syntax, the `glob:` and `regex:` lines\n**must not** start with a dash, but the lines under them **must** start with\na dash.\n\nAlso because of yaml, patterns that start with a punctuation mark must be\nquoted.\n\nWhen writing regexes, it's best to use single quotes rather than double\nquotes, so that your regex backslash escapes are preserved correctly without\nhaving to be doubled up.", "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/apenwarr/mkdocs-exclude", "keywords": "", "license": "Apache", "maintainer": "", "maintainer_email": "", "name": "mkdocs-exclude", "package_url": "https://pypi.org/project/mkdocs-exclude/", "platform": "", "project_url": "https://pypi.org/project/mkdocs-exclude/", "project_urls": { "Homepage": "https://github.com/apenwarr/mkdocs-exclude" }, "release_url": "https://pypi.org/project/mkdocs-exclude/1.0.2/", "requires_dist": null, "requires_python": "", "summary": "A mkdocs plugin that lets you exclude files or trees.", "version": "1.0.2" }, "last_serial": 4847829, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "4abf24ebd2bf5c7a6fd57760b6fcccba", "sha256": "bf220420d30ee77e76be3b7911aef007e7989baf199606cd42d69936eb831430" }, "downloads": -1, "filename": "mkdocs_exclude-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "4abf24ebd2bf5c7a6fd57760b6fcccba", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4312, "upload_time": "2019-01-07T19:13:59", "url": "https://files.pythonhosted.org/packages/74/b0/0a301edfdbe36571bddc75dc3b78c7d0094f46f0aa0511166b004024c52c/mkdocs_exclude-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c71b08fd47546c5321b37d1abdf2a109", "sha256": "4ac920f6cbe57346f869864a4b7069c34b7ca78511cddae230b3efa6d5247d17" }, "downloads": -1, "filename": "mkdocs-exclude-1.0.0.tar.gz", "has_sig": false, "md5_digest": "c71b08fd47546c5321b37d1abdf2a109", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6427, "upload_time": "2019-01-07T19:11:09", "url": "https://files.pythonhosted.org/packages/64/19/ea9d8b353ea3240abd980a44e7df6938a081981f487f275b781b0bceb98a/mkdocs-exclude-1.0.0.tar.gz" } ], "1.0.0a0": [ { "comment_text": "", "digests": { "md5": "53be0eee082ede81d9581498f70c58c8", "sha256": "532b4343ca223a9c778a225a91fc14d2c134414c2fd04abc5cd78239aed94d19" }, "downloads": -1, "filename": "mkdocs_exclude-1.0.0a0-py3-none-any.whl", "has_sig": false, "md5_digest": "53be0eee082ede81d9581498f70c58c8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4343, "upload_time": "2019-01-07T19:15:06", "url": "https://files.pythonhosted.org/packages/77/92/ea6bc54528b362ea87990f9d85e06a3b456f898532e74364cbcbeb6dee86/mkdocs_exclude-1.0.0a0-py3-none-any.whl" } ], "1.0.0a1": [ { "comment_text": "", "digests": { "md5": "d7aba1710a27b313635bf2e1f3f979c8", "sha256": "2286888186f500b9e5e2fd812f52ca8a2b45b4249c50d5b3581ccaf3eb52881d" }, "downloads": -1, "filename": "mkdocs_exclude-1.0.0a1-py3-none-any.whl", "has_sig": false, "md5_digest": "d7aba1710a27b313635bf2e1f3f979c8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4392, "upload_time": "2019-01-07T19:17:52", "url": "https://files.pythonhosted.org/packages/57/f8/f4c198fd47dc8de9819e0af08a89eadcb1e41852b82441104451f1e8968c/mkdocs_exclude-1.0.0a1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d3d67cd8eb8ec4df8f0d8cc874df9dc5", "sha256": "a1531110afe7c2a442efc24143d34b1a3562fad04eda25d30375ef5d1264c806" }, "downloads": -1, "filename": "mkdocs-exclude-1.0.0a1.tar.gz", "has_sig": false, "md5_digest": "d3d67cd8eb8ec4df8f0d8cc874df9dc5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6445, "upload_time": "2019-01-07T19:18:33", "url": "https://files.pythonhosted.org/packages/66/cb/8f5e9df8a50a741f82987cdf428ae7bd22a717e30664828561f8e176ef24/mkdocs-exclude-1.0.0a1.tar.gz" } ], "1.0.0a2": [ { "comment_text": "", "digests": { "md5": "17b7ad1ab82ae5e0299c82d31f53d968", "sha256": "fa2729264496bba1015891b9ababa709f3a117e85f5762502e2f7f3d7a6db93e" }, "downloads": -1, "filename": "mkdocs-exclude-1.0.0a2.tar.gz", "has_sig": false, "md5_digest": "17b7ad1ab82ae5e0299c82d31f53d968", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6450, "upload_time": "2019-01-07T19:20:53", "url": "https://files.pythonhosted.org/packages/85/6b/699f93d75b5532923690ff1e730f5f31a174b8de89182d5170552f636387/mkdocs-exclude-1.0.0a2.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "b3ba3e31e8cca823a67c8ceb2c2adee3", "sha256": "b7df8e52b9c03c7087784db1b1f4f168910bae377ce7af253c4cb40ceb9b7289" }, "downloads": -1, "filename": "mkdocs-exclude-1.0.1.tar.gz", "has_sig": false, "md5_digest": "b3ba3e31e8cca823a67c8ceb2c2adee3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6442, "upload_time": "2019-01-07T19:23:59", "url": "https://files.pythonhosted.org/packages/d5/79/b0e05f28d3f2385459acfdba1fd2fad9793ffadab87d4c961560ccc37fbb/mkdocs-exclude-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "b73ad0a6a4fdde5f6e06b8536133c2db", "sha256": "ba6fab3c80ddbe3fd31d3e579861fd3124513708271180a5f81846da8c7e2a51" }, "downloads": -1, "filename": "mkdocs-exclude-1.0.2.tar.gz", "has_sig": false, "md5_digest": "b73ad0a6a4fdde5f6e06b8536133c2db", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6751, "upload_time": "2019-02-20T23:34:12", "url": "https://files.pythonhosted.org/packages/54/b5/3a8e289282c9e8d7003f8a2f53d673d4fdaa81d493dc6966092d9985b6fc/mkdocs-exclude-1.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b73ad0a6a4fdde5f6e06b8536133c2db", "sha256": "ba6fab3c80ddbe3fd31d3e579861fd3124513708271180a5f81846da8c7e2a51" }, "downloads": -1, "filename": "mkdocs-exclude-1.0.2.tar.gz", "has_sig": false, "md5_digest": "b73ad0a6a4fdde5f6e06b8536133c2db", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6751, "upload_time": "2019-02-20T23:34:12", "url": "https://files.pythonhosted.org/packages/54/b5/3a8e289282c9e8d7003f8a2f53d673d4fdaa81d493dc6966092d9985b6fc/mkdocs-exclude-1.0.2.tar.gz" } ] }