{ "info": { "author": "Jared Dillard", "author_email": "jared.dillard@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: BSD License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Topic :: Documentation" ], "description": "Sphinx Gitstamp Generator Extension\n===================================\n\nA `Sphinx`_ extension that inserts a git datestamp into the context as\n``gitstamp``, to make it available for template use in HTML versions of\nyour Sphinx documentation.\n\n|Build Status| |PyPI version| |License: BSD|\n\nInstalling\n----------\n\nDirectly install via pip by using::\n\n pip install sphinx-gitstamp\n\nAdd ``sphinx_gitstamp`` to the `extensions`_ array in your Sphinx **conf.py**.\nFor example::\n\n extensions = ['sphinx_gitstamp']\n\nSet the value of ``gitstamp_fmt`` in **conf.py** to the desired date format.\nFor example::\n\n # Date format for git timestamps\n gitstamp_fmt = \"%b %d %Y\"\n\nAdd ``gitstamp`` to the template, for example::\n\n {%- if gitstamp %} Last updated on {{ gitstamp }} {%- endif %}\n\nSee Who Is Using It\n-------------------\n\nYou can use `GitHub search`_ or `libraries.io`_ to see who is using\n**sphinx-sitemap**.\n\nContributing\n------------\n\nPull Requests welcome! See `CONTRIBUTING`_ for instructions on how best to\ncontribute.\n\nMaintaining PyPI Version\n------------------------\n\nThese are the steps, to be run by the maintainer, for making a new Python\npackage release.\n\n#. Rev versions in **sphinx_gitstamp/version.py** and **setup.py**.\n#. Update **CHANGELOG.md**\n#. Create a tag and push to GitHub::\n\n git tag -a vX.Y.Z -m \"Release vX.Y.Z\"\n git push --tags origin master\n\n#. Create latest distribution locally::\n\n python setup.py sdist\n\n#. Upload to the test pypi.org repository::\n\n twine upload --repository-url https://test.pypi.org/legacy/ dist/*\n\n#. Upload to the production pypi.org repository::\n\n twine upload dist/*\n\nLicense\n-------\n\n**sphinx-gitstamp** is made available under a **BSD license**; see `LICENSE`_ for\ndetails.\n\nOriginally based on the gitstamp generator in the `cyrus-imapd`_ project. This\nproduct includes software developed by Computing Services at Carnegie Mellon\nUniversity (http://www.cmu.edu/computing/).\n\n.. _CONTRIBUTING: CONTRIBUTING.md\n.. _cyrus-imapd: https://github.com/cyrusimap/cyrus-imapd/pull/2029/files\n.. _extensions: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-extensions\n.. _GitHub search: https://github.com/search?utf8=%E2%9C%93&q=sphinx-gitstamp+extension%3Atxt&type=\n.. _gitpython: https://gitpython.readthedocs.io/en/stable/\n.. _html_extra_path: http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_extra_path\n.. _language: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language\n.. _libraries.io: https://libraries.io/pypi/sphinx-gitstamp\n.. _LICENSE: LICENSE\n.. _Sphinx: http://sphinx-doc.org/\n\n.. |Build Status| image:: https://travis-ci.org/jdillard/sphinx-gitstamp.svg?branch=master\n :target: https://travis-ci.org/jdillard/sphinx-gitstamp\n.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-gitstamp.svg\n :target: https://pypi.python.org/pypi/sphinx-gitstamp\n.. |License: BSD| image:: https://img.shields.io/badge/License-BSD-blue.svg\n :target: https://github.com/jdillard/sphinx-gitstamp/blob/master/LICENSE", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/jdillard/sphinx-gitstamp/archive/v0.3.0.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jdillard/sphinx-gitstamp", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sphinx-gitstamp", "package_url": "https://pypi.org/project/sphinx-gitstamp/", "platform": "", "project_url": "https://pypi.org/project/sphinx-gitstamp/", "project_urls": { "Download": "https://github.com/jdillard/sphinx-gitstamp/archive/v0.3.0.tar.gz", "Homepage": "https://github.com/jdillard/sphinx-gitstamp" }, "release_url": "https://pypi.org/project/sphinx-gitstamp/0.3.0/", "requires_dist": null, "requires_python": "", "summary": "git timestamp generator for Sphinx", "version": "0.3.0" }, "last_serial": 5832999, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "2093011cfb13c03d766807d3233592ba", "sha256": "b73dc673b83ec376968607b811777bdc33581c6a905b5d6d1a23bd8ac7eb921e" }, "downloads": -1, "filename": "sphinx-gitstamp-0.1.0.tar.gz", "has_sig": false, "md5_digest": "2093011cfb13c03d766807d3233592ba", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4285, "upload_time": "2019-09-13T05:22:06", "url": "https://files.pythonhosted.org/packages/3a/c3/cea9e67351dc543b8aa968bf4ee08a7f536ddcee565e201955e73f062045/sphinx-gitstamp-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "717abc2fc6bf76fd3e535ea8734a1be1", "sha256": "5be74ee1eed4e533020a742598764647befbf2e13d93b32d176343dd98be7e8c" }, "downloads": -1, "filename": "sphinx-gitstamp-0.2.0.tar.gz", "has_sig": false, "md5_digest": "717abc2fc6bf76fd3e535ea8734a1be1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4281, "upload_time": "2019-09-13T05:35:13", "url": "https://files.pythonhosted.org/packages/af/08/3172f4b3a3cae1e31731c257b2fe4f7e5c19b2720dc8af99b43bee846024/sphinx-gitstamp-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "f7d8e5fd51c332a731a1c687564b3c35", "sha256": "949de3a9d8a6793392828ec97f821953c76533b32550d107cf367c38d8780d99" }, "downloads": -1, "filename": "sphinx-gitstamp-0.3.0.tar.gz", "has_sig": false, "md5_digest": "f7d8e5fd51c332a731a1c687564b3c35", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4151, "upload_time": "2019-09-15T20:50:09", "url": "https://files.pythonhosted.org/packages/6d/1d/d9e578f0f4574386dbc76ad2ce616a02e474d6d49b4c17c46733ebbc9f3b/sphinx-gitstamp-0.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f7d8e5fd51c332a731a1c687564b3c35", "sha256": "949de3a9d8a6793392828ec97f821953c76533b32550d107cf367c38d8780d99" }, "downloads": -1, "filename": "sphinx-gitstamp-0.3.0.tar.gz", "has_sig": false, "md5_digest": "f7d8e5fd51c332a731a1c687564b3c35", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4151, "upload_time": "2019-09-15T20:50:09", "url": "https://files.pythonhosted.org/packages/6d/1d/d9e578f0f4574386dbc76ad2ce616a02e474d6d49b4c17c46733ebbc9f3b/sphinx-gitstamp-0.3.0.tar.gz" } ] }