{ "info": { "author": "Jim Porter", "author_email": "itsjimporter@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Documentation" ], "description": "mike\n====\n\n**mike** is a Python utility to easily deploy multiple versions of your\n`MkDocs `__-powered docs to a Git branch,\nsuitable for deploying to Github via ``gh-pages``.\n\nWhy Use mike?\n-------------\n\nmike is built around the idea that once you've generated your docs for a\nparticular version, you should never need to touch that version again.\nThis means you never have to worry about breaking changes in MkDocs,\nsince your old docs (built with an old version of MkDocs) are already\ngenerated and sitting in your ``gh-pages`` branch.\n\nWhile mike is flexible, it's optimized around putting your docs in a\n``.`` directory, with optional aliases (e.g. ``latest`` or\n``dev``) to particularly notable versions. This makes it easy to make\npermalinks to whatever version of the documentation you want to direct\npeople to.\n\nInstallation\n------------\n\nLike most Python projects, mike uses\n`setuptools `__, so installation\nis what you might expect:\n\n.. code:: sh\n\n pip install mike\n\nUsage\n-----\n\nBuilding Your Docs\n~~~~~~~~~~~~~~~~~~\n\nBefore your first build, you'll probably want to add the version\nselector to your MkDocs config. Simply run the following command in the\ndirectory with your ``mkdocs.yml`` file to install the extra CSS and JS\nfiles to your docs:\n\n.. code:: sh\n\n mike install-extras\n\nmike is designed to produce one version of your docs at a time. That\nway, you can easily deploy a new version without touching any older\nversions of your docs; this can be especially important if your old docs\nare no longer buildable with the newest version of MkDocs (or if they\nweren't built with MkDocs at all!). To deploy the current version of\nyour docs, simply run:\n\n.. code:: sh\n\n mike deploy [version]\n\nWhere ``[version]`` is the current version of your project, represented\nhowever you like (I recommend using ``[major].[minor]`` and excluding\nthe patch number). You can also pass aliases to the ``deploy`` command\nto host a particularly-relevant version of your docs somewhere special\n(e.g. ``latest``):\n\n.. code:: sh\n\n mike deploy [version] [alias]...\n\nIf you'd like to specify a title for this version that doesn't match the\nversion string, you can pass ``-t TITLE``/``--title=TITLE`` as well. If\n``version`` already exists, this command will *also* update all of the\npre-existing aliases for it.\n\nFinally, to push your docs to a remote branch, simply add\n``-p``/``--push`` to your command.\n\nViewing Your Docs\n~~~~~~~~~~~~~~~~~\n\nTo test that your docs have been built as expected, you can serve them\nlocally from a dev server:\n\n.. code:: sh\n\n mike serve\n\nBy default, this serves the docs on ``http://localhost:8000``, but you\ncan change this with ``-a``/``--dev-addr``.\n\nDeleting Docs\n~~~~~~~~~~~~~\n\nSometimes you need to delete an old version of your docs, either because\nyou made a mistake or you're pruning unsupported versions. You can do\nthis via the ``delete`` subcommand:\n\n.. code:: sh\n\n mike delete [version-or-alias]...\n\nIf ``version-or-alias`` is a version, this will delete the version and\nall its aliases from the branch; if it's an alias, it will only delete\nthat alias.\n\nIf you'd like to *completely* wipe the contents of your docs branch,\njust run ``mike delete --all``. Like ``deploy`` above, you can specify\n``-p``/``--push`` to push this commit as well.\n\nListing Docs\n~~~~~~~~~~~~\n\nIf you ever need to see the list of all currently-deployed doc versions,\nyou can run:\n\n.. code:: sh\n\n mike list\n\nSetting the Default Version\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nWith all the versions of docs you have, you may want to set a *default*\nversion so that people going to the root of your site are redirected to\nthe latest version of the docs:\n\n.. code:: sh\n\n mike set-default [version-or-alias]\n\nLike ``deploy`` and ``delete`` above, you can specify ``-p``/``--push``\nto\\` push this commit as well.\n\nChanging a Version's Title\n~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAs you update your docs, you may want to change the title of a\nparticular version. For example, your ``1.0`` docs might have the title\n``1.0.0``, and when you release a new patch, you want to update the\ntitle to ``1.0.1``. You can do this with the ``retitle`` command:\n\n.. code:: sh\n\n mike retitle [version-or-alias] [title]\n\nAs with other commands that change your docs, you can specify\n``-p``/``--push`` to push this commit.\n\nAdding a New Version Alias\n~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nSometimes, you might need to add a new alias for a version without\nrebuilding your documentation. You can use the ``alias`` command for\nthis:\n\n.. code:: sh\n\n mike alias [version-or-alias] [alias]...\n\nOnce again, you can specify ``-p``/``--push`` to push this commit.\n\nMore Details\n~~~~~~~~~~~~\n\nFor more details on the available options (e.g. specifying which branch\nto push to), consult the ``--help`` command for mike.\n\nStaying in Sync\n---------------\n\nmike will do its best to stay in-sync with your remote repository and\nwill automatically update your local branch to match the remote's if\npossible (note that mike *won't* automatically ``git fetch`` anything).\nIf your local branch has diverged from your remote, mike will leave it\nas-is and ask you what to do. To ignore the remote's state, just pass\n``--ignore``; to update to the remote's state, pass ``--rebase``.\n\nFor Theme Authors\n-----------------\n\nIf you'd like to provide support for mike in your theme, you just need\nto fetch ``versions.json`` and build a version selector.\n``versions.json`` looks like this:\n\n.. code:: js\n\n [\n {\"version\": \"1.0\", \"title\": \"1.0.1\", \"aliases\": [\"latest\"]},\n {\"version\": \"0.9\", \"title\": \"0.9\", \"aliases\": []}\n ]\n\nTo see an example of how to work with this, check the\n```mike/themes/mkdocs`` `__ directory.\n\nLicense\n-------\n\nThis project is licensed under the `BSD 3-clause license `__.\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/jimporter/mike", "keywords": "mkdocs multiple versions", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "mike", "package_url": "https://pypi.org/project/mike/", "platform": "", "project_url": "https://pypi.org/project/mike/", "project_urls": { "Homepage": "https://github.com/jimporter/mike" }, "release_url": "https://pypi.org/project/mike/0.3.5/", "requires_dist": [ "mkdocs (>=0.17.0)", "jinja2", "packaging", "ruamel.yaml", "six", "enum34; python_version < \"3.4\"", "coverage; extra == 'dev'", "flake8 (>=3.0); extra == 'dev'", "mock; extra == 'dev'", "pypandoc; extra == 'dev'", "coverage; extra == 'test'", "flake8 (>=3.0); extra == 'test'", "mock; extra == 'test'" ], "requires_python": "", "summary": "Manage multiple versions of your MkDocs-powered documentation", "version": "0.3.5" }, "last_serial": 4453814, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "ab767145d98cf319d6189008861496ac", "sha256": "bb88121ef6563d4975bea803255bb3f54f364a1adee0e461ebef42ccd3cdff1f" }, "downloads": -1, "filename": "mike-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ab767145d98cf319d6189008861496ac", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 16185, "upload_time": "2017-12-04T03:16:52", "url": "https://files.pythonhosted.org/packages/12/70/861b1fe65bcec7aeff152d37b6da283c4e9ca1ccd9bf4a26e9c2c5f3015e/mike-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f56f5473b7811427d36cd95f3c8d840c", "sha256": "cc51b0d9ec5de108f11bd69e74735550211a5dc13714cab565250d208226f980" }, "downloads": -1, "filename": "mike-0.1.1.tar.gz", "has_sig": false, "md5_digest": "f56f5473b7811427d36cd95f3c8d840c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11357, "upload_time": "2017-12-04T03:16:53", "url": "https://files.pythonhosted.org/packages/22/6b/e03ae2a679a7c85d411d22b2b70a6ec5fc52603e06c9bca747b78c5c07f5/mike-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "075eed1a0afcbe75b80a6900ad04bbea", "sha256": "affcd71cfdc6e65c1b034ca6b6eee4c3ac5349af3aec4c6efbd44fad63d2c705" }, "downloads": -1, "filename": "mike-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "075eed1a0afcbe75b80a6900ad04bbea", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 17998, "upload_time": "2018-04-09T03:21:33", "url": "https://files.pythonhosted.org/packages/36/2d/e7573bd5acd609422a8d21903ff736d43b9d79da3e52f508716c6859381a/mike-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "955968e218bb181b7b5d937dbffe1dde", "sha256": "e61db9bd903475ef0c01e6e0530e2cfdc2c767f6d3ac0d707c58549e9123e116" }, "downloads": -1, "filename": "mike-0.2.0.tar.gz", "has_sig": false, "md5_digest": "955968e218bb181b7b5d937dbffe1dde", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13926, "upload_time": "2018-04-09T03:21:34", "url": "https://files.pythonhosted.org/packages/1c/43/c98fc1a47c14f0c4bef7364720f00b2fd162e329711419c0a83e9add370b/mike-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "04ee64527271a7256dd1ed95729ed26d", "sha256": "8691f88b76ba442a89a954d6cf73f8c990c59e068eb766f92a1256d227a01d70" }, "downloads": -1, "filename": "mike-0.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "04ee64527271a7256dd1ed95729ed26d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 20052, "upload_time": "2018-04-15T01:47:56", "url": "https://files.pythonhosted.org/packages/fd/11/8e95c02050fb762f637fbcd3682315353c73883ea71128834dae9b5b129f/mike-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d427f95668513051c8d7949de1eeca7d", "sha256": "1fa5fd49d09571b89830f486d69d1324b3701477effc745499fcbfb4e5d54860" }, "downloads": -1, "filename": "mike-0.3.0.tar.gz", "has_sig": false, "md5_digest": "d427f95668513051c8d7949de1eeca7d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16005, "upload_time": "2018-04-15T01:47:57", "url": "https://files.pythonhosted.org/packages/95/f1/05b1c5f27a84857e1769753d78cfc9184e32aee04caad759948400c998fc/mike-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "aed7eb6142e4ce3a01c8a98cd17d6df2", "sha256": "618aa2c80bc583ed91a21eab2fa2441660303ffab520219275845d74430b69f5" }, "downloads": -1, "filename": "mike-0.3.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "aed7eb6142e4ce3a01c8a98cd17d6df2", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 20083, "upload_time": "2018-04-15T02:46:42", "url": "https://files.pythonhosted.org/packages/53/39/c2add41e017778d69c4893bc5a35222746839dff5ac93c16cfd50383bbcf/mike-0.3.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "000e844d31afb86afb6457d2164973a3", "sha256": "92515958c88c03c0cdb398e2b805d101d0cdd0bf25491152154b63d37e908d39" }, "downloads": -1, "filename": "mike-0.3.1.tar.gz", "has_sig": false, "md5_digest": "000e844d31afb86afb6457d2164973a3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16037, "upload_time": "2018-04-15T02:46:43", "url": "https://files.pythonhosted.org/packages/dc/e6/c3d7e4c61cfcdc1b184abb42c60f80a7e4894ab4ef984d179ecbcf30931e/mike-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "77fef694d617227b2d7170f000aa87b4", "sha256": "c8b0ad936183c399ef06f657777461edbb041ea71e8c182376a1fb71bd261ece" }, "downloads": -1, "filename": "mike-0.3.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "77fef694d617227b2d7170f000aa87b4", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 20645, "upload_time": "2018-04-26T19:54:21", "url": "https://files.pythonhosted.org/packages/70/5f/8eb687c6b71a449fa7635d5c12a77ef76e5d49a9c362c7028b4262f3049e/mike-0.3.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "50c4cd6420941b53fb84e9f2aa5253b0", "sha256": "42667023f355a6c8378a62291f5daebb78b120ec88dfe66be804d880f82cdb89" }, "downloads": -1, "filename": "mike-0.3.2.tar.gz", "has_sig": false, "md5_digest": "50c4cd6420941b53fb84e9f2aa5253b0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16621, "upload_time": "2018-04-26T19:54:22", "url": "https://files.pythonhosted.org/packages/23/03/02831c3702f844950f82792da80032884d148cc96d62e591059d39a962aa/mike-0.3.2.tar.gz" } ], "0.3.3": [ { "comment_text": "", "digests": { "md5": "19d08dcac918ae94cfbaa56ebe2b99bc", "sha256": "9c2f8d0003c9c6857e76ed3ffd8363724d388fb5b16656890b555ca4567ad3f1" }, "downloads": -1, "filename": "mike-0.3.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "19d08dcac918ae94cfbaa56ebe2b99bc", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 20636, "upload_time": "2018-09-02T02:49:21", "url": "https://files.pythonhosted.org/packages/c5/ee/38e13905b238b868d1f1666247c2dfd6b2766460009b81d32f38215859a7/mike-0.3.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "47689faa432c712b96fdb897283b9c0c", "sha256": "051e401ab31c82c76d9ec2ed441f9dc142b5a0a7c827e883cfb84647e5e34850" }, "downloads": -1, "filename": "mike-0.3.3.tar.gz", "has_sig": false, "md5_digest": "47689faa432c712b96fdb897283b9c0c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16626, "upload_time": "2018-09-02T02:49:23", "url": "https://files.pythonhosted.org/packages/c0/f0/03310b7b2a78421c622c002add09c3445cc56ab4eaccde54b5b6341a2b56/mike-0.3.3.tar.gz" } ], "0.3.4": [ { "comment_text": "", "digests": { "md5": "91a5c09a353fffeca1869e43576b6a82", "sha256": "2e7f01da2282e0cfde8682ef657172f61f8a91f67e437271321562b856241dc0" }, "downloads": -1, "filename": "mike-0.3.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "91a5c09a353fffeca1869e43576b6a82", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 20939, "upload_time": "2018-09-08T21:13:07", "url": "https://files.pythonhosted.org/packages/1c/df/fa8d9a0da5ce4c8e4633a5c2bf0344076ddf60130587de90efdc8c579aa8/mike-0.3.4-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "65d8bb7f5bf869a50638e88837aebeca", "sha256": "446fcc1ea11497f2c1f7af0a44700be84ee90ffe051f74b2560d04d81b9e3196" }, "downloads": -1, "filename": "mike-0.3.4.tar.gz", "has_sig": false, "md5_digest": "65d8bb7f5bf869a50638e88837aebeca", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16822, "upload_time": "2018-09-08T21:13:08", "url": "https://files.pythonhosted.org/packages/d7/85/d92001382017cd02c7966433ea193cd86d5e7f413938cd4889244cf16490/mike-0.3.4.tar.gz" } ], "0.3.5": [ { "comment_text": "", "digests": { "md5": "2046eaa13ad7fb877c0c0b3e5a21ed66", "sha256": "15f4adb6e3ef9968ddbc4532aa7cea806399bf3c5d1d8028f21f60bb157311dc" }, "downloads": -1, "filename": "mike-0.3.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "2046eaa13ad7fb877c0c0b3e5a21ed66", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 18405, "upload_time": "2018-11-05T17:09:56", "url": "https://files.pythonhosted.org/packages/a2/a9/4a53afb73eab8bf271891ff443b0debfa88bf19b0fe0381cd16c9fd074ee/mike-0.3.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "42399796f64434c608a9278423459f51", "sha256": "ac3706c0c911e4f02f640cb17ecae1ab2157cc6a351260b9353288e39b8a9862" }, "downloads": -1, "filename": "mike-0.3.5.tar.gz", "has_sig": false, "md5_digest": "42399796f64434c608a9278423459f51", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15483, "upload_time": "2018-11-05T17:09:58", "url": "https://files.pythonhosted.org/packages/4c/4f/c18d79328b8b4c4273b92c04a6158e559b973859657f877dca44d7e5a28d/mike-0.3.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "2046eaa13ad7fb877c0c0b3e5a21ed66", "sha256": "15f4adb6e3ef9968ddbc4532aa7cea806399bf3c5d1d8028f21f60bb157311dc" }, "downloads": -1, "filename": "mike-0.3.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "2046eaa13ad7fb877c0c0b3e5a21ed66", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 18405, "upload_time": "2018-11-05T17:09:56", "url": "https://files.pythonhosted.org/packages/a2/a9/4a53afb73eab8bf271891ff443b0debfa88bf19b0fe0381cd16c9fd074ee/mike-0.3.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "42399796f64434c608a9278423459f51", "sha256": "ac3706c0c911e4f02f640cb17ecae1ab2157cc6a351260b9353288e39b8a9862" }, "downloads": -1, "filename": "mike-0.3.5.tar.gz", "has_sig": false, "md5_digest": "42399796f64434c608a9278423459f51", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15483, "upload_time": "2018-11-05T17:09:58", "url": "https://files.pythonhosted.org/packages/4c/4f/c18d79328b8b4c4273b92c04a6158e559b973859657f877dca44d7e5a28d/mike-0.3.5.tar.gz" } ] }