Automatically generates a contributors page by analyzing your Git repository history. Shows who has contributed to your documentation and project with configurable display options.

What it generates

• List of all contributors with commit counts
• Avatar images from GitHub profiles
• Customizable contributor cards with name, GitHub link, and stats
• Optional filtering by file patterns or commit types
• Sorting options (alphabetical, by commit count, by date)

Example output

Creates a page showing:

John Doe (25 commits)
Jane Smith (18 commits)
Bob Wilson (12 commits)

With GitHub avatars and links to profiles when available.

Configuration options

# conf.py
extensions = ['sphinx_contributors']

# Basic configuration
contributors_github_repo = "owner/repo-name"

# Optional: filter contributors
contributors_filter_commits = ["docs/", "*.md", "*.rst"]  # Only count these files
contributors_exclude_emails = ["noreply@github.com"]      # Exclude these emails
contributors_min_commits = 2                              # Minimum commits to appear

# Optional: customize display
contributors_show_avatars = True
contributors_show_links = True
contributors_sort_by = "commits"  # or "name" or "date"

Use cases

• Open source projects wanting to acknowledge contributors
• Team documentation with attribution
• Project websites showing development activity
• Recognition pages for community contributions

Requires the documentation to be in a Git repository. Works with GitHub, GitLab, and other Git hosting services.