sphinx-contributor-listing 0.0.1

A Sphinx extension for adding contributor listings to documentation pages.

sphinx-contributor-listing

sphinx-contributor-listing adds contributor information to Sphinx documentation pages by extracting Git commit history and displaying contributor names with links to their latest commits.

Basic usage

After installing and configuring the extension, contributor information becomes available in your Sphinx templates through the get_contributors_for_file function. This function can be used in custom templates to display contributor information for specific pages.

The extension automatically:

• Extracts commit history from the Git repository
• Identifies all contributors (including co-authors) for each file
• Provides links to the contributors' latest commits
• Supports filtering by date range

Project setup

sphinx-contributor-listing can be installed with:

pip install sphinx-contributor-listing

After adding sphinx-contributor-listing to your Python project, update your Sphinx's conf.py file to include sphinx-contributor-listing as one of its extensions:

extensions = [
    "sphinx_contributor_listing"
]

# Configuration options
display_contributors = True  # Enable contributor display
github_folder = "/docs/"     # Path to documentation folder in repository
github_url = "https://github.com/your-org/your-repo"  # Base URL for commit links

# Optional: Filter commits by date
display_contributors_since = "2024-01-01"  # Only show contributors since this date

Community and support

You can report any issues or bugs on the project's GitHub repository.

sphinx-contributor-listing is covered by the Ubuntu Code of Conduct.

License and copyright

sphinx-contributor-listing is released under the GPL-3.0 license.

© 2025 Canonical Ltd.