| Name | sphinx-gitstamp JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | |
| Summary | git timestamp generator for Sphinx |
| upload_time | 2023-09-27 04:47:55 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Sphinx Gitstamp Generator Extension
===================================
A `Sphinx`_ extension that inserts a git datestamp into the context as
``gitstamp``, to make it available for template use in HTML versions of
your Sphinx documentation.
|PyPI version| |Downloads| |Code style: Black| |Parallel Safe|
Installing
----------
Directly install via pip by using::
pip install sphinx-gitstamp
Add ``sphinx_gitstamp`` to the `extensions`_ array in your Sphinx **conf.py**.
For example:
.. code-block:: python
extensions = ['sphinx_gitstamp']
To change the default time format of ``%b %d, %Y``, set the value of ``gitstamp_fmt`` in **conf.py** to the desired `time format`_.
For example:
.. code-block:: python
# Date format for git timestamps
gitstamp_fmt = "%Y-%m-%d %H:%M:%S %z"
Add ``gitstamp`` to the jinja template, for example:
.. code-block:: jinja
{%- if gitstamp %} This page was last updated on {{ gitstamp }}. {%- endif %}
Contributing
------------
Pull Requests welcome! See `CONTRIBUTING`_ for instructions on how best to
contribute.
License
-------
**sphinx-gitstamp** is made available under a **BSD license**; see `LICENSE`_ for
details.
Originally based on the gitstamp generator in the `cyrus-imapd`_ project. This
product includes software developed by Computing Services at Carnegie Mellon
University (http://www.cmu.edu/computing/).
.. _CONTRIBUTING: CONTRIBUTING.md
.. _cyrus-imapd: https://github.com/cyrusimap/cyrus-imapd/pull/2029/files
.. _extensions: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-extensions
.. _gitpython: https://gitpython.readthedocs.io/en/stable/
.. _html_extra_path: http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_extra_path
.. _language: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language
.. _LICENSE: LICENSE
.. _Sphinx: http://sphinx-doc.org/
.. _time format: https://docs.python.org/2/library/time.html#time.strftime
.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-gitstamp.svg
:target: https://pypi.python.org/pypi/sphinx-gitstamp
.. |Downloads| image:: https://static.pepy.tech/badge/sphinx-gitstamp/month
:target: https://pepy.tech/project/sphinx-gitstamp
.. |Code style: Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. |Parallel Safe| image:: https://img.shields.io/badge/parallel%20safe-true-brightgreen
Raw data
{
"_id": null,
"home_page": "",
"name": "sphinx-gitstamp",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "Jared Dillard <jared.dillard@gmail.com>",
"keywords": "",
"author": "",
"author_email": "Jared Dillard <jared.dillard@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/35/bc/286392c851b0ce65163b4c4e5bb9bca3b6b33198f990ce9f3756797554a7/sphinx-gitstamp-0.4.0.tar.gz",
"platform": null,
"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|PyPI version| |Downloads| |Code style: Black| |Parallel Safe|\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.. code-block:: python\n\n extensions = ['sphinx_gitstamp']\n\nTo change the default time format of ``%b %d, %Y``, set the value of ``gitstamp_fmt`` in **conf.py** to the desired `time format`_.\nFor example:\n\n.. code-block:: python\n\n # Date format for git timestamps\n gitstamp_fmt = \"%Y-%m-%d %H:%M:%S %z\"\n\nAdd ``gitstamp`` to the jinja template, for example:\n\n.. code-block:: jinja\n\n {%- if gitstamp %} This page was last updated on {{ gitstamp }}. {%- endif %}\n\nContributing\n------------\n\nPull Requests welcome! See `CONTRIBUTING`_ for instructions on how best to\ncontribute.\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.. _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.. _LICENSE: LICENSE\n.. _Sphinx: http://sphinx-doc.org/\n.. _time format: https://docs.python.org/2/library/time.html#time.strftime\n\n.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-gitstamp.svg\n :target: https://pypi.python.org/pypi/sphinx-gitstamp\n.. |Downloads| image:: https://static.pepy.tech/badge/sphinx-gitstamp/month\n :target: https://pepy.tech/project/sphinx-gitstamp\n.. |Code style: Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n.. |Parallel Safe| image:: https://img.shields.io/badge/parallel%20safe-true-brightgreen\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "git timestamp generator for Sphinx",
"version": "0.4.0",
"project_urls": {
"download": "https://pypi.org/project/sphinx-gitstamp/",
"source": "https://github.com/jdillard/sphinx-gitstamp"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c7e4af3cf990b4cd5df43d764c9474a214537cf0ec5109ec2f6c64121d4ae46",
"md5": "eef7a1ce397df3815890a7e5f8dd6de0",
"sha256": "c0a32a0033ebeb1b65f6cd41e10a92c16ca4633dbab44e6841016369adab5160"
},
"downloads": -1,
"filename": "sphinx_gitstamp-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eef7a1ce397df3815890a7e5f8dd6de0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6113,
"upload_time": "2023-09-27T04:47:54",
"upload_time_iso_8601": "2023-09-27T04:47:54.142619Z",
"url": "https://files.pythonhosted.org/packages/5c/7e/4af3cf990b4cd5df43d764c9474a214537cf0ec5109ec2f6c64121d4ae46/sphinx_gitstamp-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "35bc286392c851b0ce65163b4c4e5bb9bca3b6b33198f990ce9f3756797554a7",
"md5": "519bead7cec598ae15f532a3bac0bf3e",
"sha256": "ef88b78cba7a1507455f47bbbfc2f073529b3bb2029eef974dbd5357ff9afc49"
},
"downloads": -1,
"filename": "sphinx-gitstamp-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "519bead7cec598ae15f532a3bac0bf3e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5600,
"upload_time": "2023-09-27T04:47:55",
"upload_time_iso_8601": "2023-09-27T04:47:55.971600Z",
"url": "https://files.pythonhosted.org/packages/35/bc/286392c851b0ce65163b4c4e5bb9bca3b6b33198f990ce9f3756797554a7/sphinx-gitstamp-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-27 04:47:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jdillard",
"github_project": "sphinx-gitstamp",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sphinx-gitstamp"
}
