{ "info": { "author": "Jonathan Gray", "author_email": "jonathan.gray@nanosheep.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "Natural Language :: English", "Operating System :: MacOS :: MacOS X", "Operating System :: POSIX", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 3.6" ], "description": "# mkversion\n\nmkversion is a plugin for [MkDocs](https://mkdocs.org) which helps version your docs.\n\n## Install\n\n`pip install mkversion`\n\n## Usage\n\nAdd `mkversion` to your list of plugins, making sure it is the _last_ plugin. To build a specific docs version set the `docs_version` key in `mkdocs.yml` to either the name of the version, or the name of an environment variable containing the version number. For example:\n\n```yaml\nplugins:\n - mkversion:\n docs_version: VERSION_ENV_VARIABLE\n```\n\nIf not set, the version will default to a Docker-style `latest`.\n\n`mkversion` can (optionally) inject a javascript [version selection dropdown](https://github.com/greenape/mkversion/blob/master/mkversion/version-select.js) into your docs. To enable this, set the `inject_js` key in `mkdocs.yml` to `true`. By default (and fine for the default mkdocs theme) the dropdown will be inserted into the navbar at the top of the docs, but you can override this by specifying which element to attach to using the `containing_div` key. For example, if you are using the [material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme, you might wish to set this to `\"div.md-footer-meta__inner\"`, which would place the version dropdown in the bottom bar, next to the copyright text,\n\nBuild, serve and deploy as you normally would.\n\n`mkversion` will build any version _other_ than `latest` in a subdirectory of the site, and will update _only_ the version being built - any previously built versions will never be changed unless you explicitly rebuild that version.\n\n## Extra Info\n\n`mkversion` adds the supplied version into the meta for each page, so for any theme which supports showing the version, this will just work. `mkversion` also adds a `versions.json` file to the root of your site, which contains all the versions built and is updated when a new version (other than latest) is built.\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/greenape/mkversion", "keywords": "mkdocs documentation markdown", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "mkversion", "package_url": "https://pypi.org/project/mkversion/", "platform": "MacOS X", "project_url": "https://pypi.org/project/mkversion/", "project_urls": { "Homepage": "https://github.com/greenape/mkversion" }, "release_url": "https://pypi.org/project/mkversion/0.1.6/", "requires_dist": [ "mkdocs", "pytest ; extra == 'tests'" ], "requires_python": "", "summary": "Plugin for mkdocs to generate versioned docs from git tags.", "version": "0.1.6" }, "last_serial": 4927340, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "19fce14a1f13434e8ccf7c7e816f5324", "sha256": "7f3471063cd8c4b641316b24fd316891421a731180ea943089819382d853ad8d" }, "downloads": -1, "filename": "mkversion-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "19fce14a1f13434e8ccf7c7e816f5324", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6659, "upload_time": "2019-03-11T13:07:32", "url": "https://files.pythonhosted.org/packages/16/61/54ec75c72753cf53bb87021a6098242f992b3806f759405530dd7aefbda3/mkversion-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ac015685a6b2744ac6bffa7f3b06f2e6", "sha256": "585a7b83e7ec9f0b227170ceb4eb5aec08619ba2ed4a193d1002cabec28dcd25" }, "downloads": -1, "filename": "mkversion-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "ac015685a6b2744ac6bffa7f3b06f2e6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6625, "upload_time": "2019-03-11T20:47:38", "url": "https://files.pythonhosted.org/packages/f9/4b/7ce0a78d223fce94b95212de0bbbb5b0c9c6673b84230f813b1c3a081a0d/mkversion-0.1-py3-none-any.whl" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "4cd66a9a8c28807ab518d0471f25954d", "sha256": "938642b7c3074f7635a51359a082cd562db2db357cf4035c80d67a8a74b81606" }, "downloads": -1, "filename": "mkversion-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "4cd66a9a8c28807ab518d0471f25954d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6556, "upload_time": "2019-03-11T20:47:38", "url": "https://files.pythonhosted.org/packages/55/16/e59a37b5149e75f9f62da170bfd883394985e46b3073a117775018f85ee4/mkversion-0.1.1-py3-none-any.whl" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "1c64cac77c715110258a6fcaba167efd", "sha256": "b2330ba626126fdad0d6dfd2d17def86c55866b4a90b5333889eb224743f99fa" }, "downloads": -1, "filename": "mkversion-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "1c64cac77c715110258a6fcaba167efd", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6563, "upload_time": "2019-03-11T20:58:03", "url": "https://files.pythonhosted.org/packages/4b/9c/b4e71456d138f54934a14759487b59de3ef462d50e30c043a5cc3a1a2baf/mkversion-0.1.2-py3-none-any.whl" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "6ecbf32a462350dfa639673c397b0602", "sha256": "7a759ead1dbb8c1ca387f5785fddab3bd5b9328e26da919ca7292ab3638bf0f8" }, "downloads": -1, "filename": "mkversion-0.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "6ecbf32a462350dfa639673c397b0602", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6564, "upload_time": "2019-03-11T21:19:57", "url": "https://files.pythonhosted.org/packages/53/7d/9cb429eb2edf70e6f2b3b296d251dab0108e5bb824698a4ccc83ded169ff/mkversion-0.1.3-py3-none-any.whl" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "f01a4973279b3603a7a34ebbc7c80df1", "sha256": "99ece25aca7e4d8584d86a9bd042f7e222b81b0b544fc7e9751d276a30638d93" }, "downloads": -1, "filename": "mkversion-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "f01a4973279b3603a7a34ebbc7c80df1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6564, "upload_time": "2019-03-11T21:34:52", "url": "https://files.pythonhosted.org/packages/41/58/5111f740d25bdde7fc0e1c496568573abc4c396bfbd59046f20c0d10da37/mkversion-0.1.4-py3-none-any.whl" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "7e96623b03394e2d16a44fe6da69f5af", "sha256": "d75e7dd227a3762f7f2338e5bee1fa86a0c7e05caad33442b6beebdbbdd98145" }, "downloads": -1, "filename": "mkversion-0.1.6-py3-none-any.whl", "has_sig": false, "md5_digest": "7e96623b03394e2d16a44fe6da69f5af", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6573, "upload_time": "2019-03-11T22:24:33", "url": "https://files.pythonhosted.org/packages/aa/88/a53607088ff8d8afe833bc8b0a7b569561428efa4bfec4e8505829a423dd/mkversion-0.1.6-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7e96623b03394e2d16a44fe6da69f5af", "sha256": "d75e7dd227a3762f7f2338e5bee1fa86a0c7e05caad33442b6beebdbbdd98145" }, "downloads": -1, "filename": "mkversion-0.1.6-py3-none-any.whl", "has_sig": false, "md5_digest": "7e96623b03394e2d16a44fe6da69f5af", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6573, "upload_time": "2019-03-11T22:24:33", "url": "https://files.pythonhosted.org/packages/aa/88/a53607088ff8d8afe833bc8b0a7b569561428efa4bfec4e8505829a423dd/mkversion-0.1.6-py3-none-any.whl" } ] }