Skip to content

sphinx-git allows you to include excerpts from your git history within your documentation #64

Open
@coding-to-music

Description

@coding-to-music

sphinx-git
https://github.com/OddBloke/sphinx-git
sphinx-git is an extension to the Sphinx documentation tool that allows you to include excerpts from your git history within your documentation. This could be used for release changelogs, to pick out specific examples of history in documentation, or just to surface what is happening in the project.

To use it, add 'sphinx_git' to 'extensions' in your Sphinx conf.py, and add:

.. git_changelog::
where you want the list of commits to appear.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions