pax_global_header 0000666 0000000 0000000 00000000064 14357312640 0014517 g ustar 00root root 0000000 0000000 52 comment=5f483576b5f21be5168f3e9469e7c67208aaf9d8
sphinx-contributors-0.2.7/ 0000775 0000000 0000000 00000000000 14357312640 0015571 5 ustar 00root root 0000000 0000000 sphinx-contributors-0.2.7/.flake8 0000664 0000000 0000000 00000000036 14357312640 0016743 0 ustar 00root root 0000000 0000000 [flake8]
max-line-length = 88
sphinx-contributors-0.2.7/.github/ 0000775 0000000 0000000 00000000000 14357312640 0017131 5 ustar 00root root 0000000 0000000 sphinx-contributors-0.2.7/.github/dependabot.yml 0000664 0000000 0000000 00000000436 14357312640 0021764 0 ustar 00root root 0000000 0000000 version: 2
updates:
# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
# Maintain dependencies for Poetry
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "daily"
sphinx-contributors-0.2.7/.github/workflows/ 0000775 0000000 0000000 00000000000 14357312640 0021166 5 ustar 00root root 0000000 0000000 sphinx-contributors-0.2.7/.github/workflows/ci.yml 0000664 0000000 0000000 00000001271 14357312640 0022305 0 ustar 00root root 0000000 0000000 ---
name: CI
on:
push:
branches: [master]
pull_request:
branches: [master]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.9, 3.8 ,3.7]
steps:
- uses: actions/checkout@v3
- name: "Set up Python"
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: "Install dependencies"
run: |
python -m pip install .[test,doc]
- name: "Lint code"
run: |
pre-commit run --all-files
- name: "Build sample"
run: |
make -C docs dirhtml
- name: "Run tests"
run: |
pytest -vvv
sphinx-contributors-0.2.7/.gitignore 0000664 0000000 0000000 00000000164 14357312640 0017562 0 ustar 00root root 0000000 0000000 .coverage
.DS_Store
.eggs
.idea
.pypirc
.pytest_cache
*pyc
*.egg-info
coverage.xml
dist
docs/build
__pycache__
venv
sphinx-contributors-0.2.7/.pre-commit-config.yaml 0000664 0000000 0000000 00000001027 14357312640 0022052 0 ustar 00root root 0000000 0000000 repos:
- repo: https://github.com/pycqa/isort
rev: 5.10.1
hooks:
- id: isort
name: isort (python)
- repo: https://github.com/psf/black
rev: 22.10.0
hooks:
- id: black
exclude: ^venv/
- repo: https://github.com/pycqa/flake8
rev: '4.0.1'
hooks:
- id: flake8
exclude: ^venv/
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.1.0
hooks:
- id: end-of-file-fixer
- id: trailing-whitespace
- id: check-yaml
- id: check-json
sphinx-contributors-0.2.7/.readthedocs.yml 0000664 0000000 0000000 00000000743 14357312640 0020663 0 ustar 00root root 0000000 0000000 # Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py
# Optionally build your docs in additional formats such as PDF and ePub
formats: []
# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.8
install:
- requirements: docs/requirements.txt
sphinx-contributors-0.2.7/CHANGELOG.rst 0000664 0000000 0000000 00000004612 14357312640 0017615 0 ustar 00root root 0000000 0000000 =========
Changelog
=========
All notable changes to this project will be documented in this file.
The format is based on `Keep a Changelog `_,
and this project adheres to `Semantic Versioning `_.
[0.2.7] - 10 January 2023
=========================
Added
-----
- [#27](https://github.com/dgarcia360/sphinx-contributors/pull/27) Sphinx extension classifier - thanks @jdillard!
Updated
-------
- [#28](https://github.com/dgarcia360/sphinx-contributors/pull/28): Black dependency for pre-commit - thanks @jdillard!
[0.2.6] - 26 January 2022
=========================
Added
-----
- Default CSS for lists.
[0.2.4] - 21 January 2022
=========================
Added
-----
- Linting with pre-commit.
Updated
-------
- Breaking change: The package is now named ``sphinx-contributors``.
- Breaking change: The required Sphinx version is at least 3.0.
- Replaced Travis CI for GitHub Actions.
- Replaced ``setup.py`` for ``pyproject.toml``.
[0.2.3] - 25 November 2021
==========================
Added
-----
* [#1](https://github.com/dgarcia360/sphinx-contributors/issues/1): The directive supports an option to render contributor's avatars - thanks @segfaultxavi!
* [#3])(https://github.com/dgarcia360/sphinx-contributors/issues/3): The docs now explain how to render contributors in a grid view.
* [#4](https://github.com/dgarcia360/sphinx-contributors/issues/4): The directive supports an option to hide the number of commits done by a contributor.
* [#13](https://github.com/dgarcia360/sphinx-contributors/issues/13): Docs for this extesion are now hosted on ReadTheDocs.
Updated
-------
* The extension now raises a warning instead of an error if the repository cannot be retrieved. This is especially useful when trying to build docs without internet connection.
[0.2.2] - 03 August 2019
========================
Added
-----
* [#2](https://github.com/dgarcia360/sphinx-contributors/issues/2): The directive supports an option to limit the number of contributors.
* The directive supports an option to sort contributors per number of commits.
* The directive supports an option to exclude usernames from the contributors' list.
Changed
--------
* Before, the repository name was passed as an option. Now, the directive accepts the repository name as an argument.
[0.1.0] - 18 July 2018
=======================
Added
-----
* Initial code release
sphinx-contributors-0.2.7/LICENSE.md 0000664 0000000 0000000 00000002071 14357312640 0017175 0 ustar 00root root 0000000 0000000 Copyright (c) 2018 - present David Garcia (@dgarcia360).
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
sphinx-contributors-0.2.7/README.rst 0000664 0000000 0000000 00000003213 14357312640 0017257 0 ustar 00root root 0000000 0000000 sphinx-contributors
===================
``sphinx-contributors`` is a Sphinx extension that helps you recognize the people who have contributed to an open-source project.
.. image:: https://raw.githubusercontent.com/dgarcia360/sphinx-contributors/master/docs/source/_static/example_avatars.png
Features
---------
**Celebrate contributions**
Show the list of users who have contributed to a repository in your docs.
**Configurable**
Choose how many contributors show and sort them by the number of commits.
Supported platforms
---------------------
``sphinx-contributors`` only works with GitHub public repositories.
Installation
------------
#. Install ``sphinx-contributors`` using PIP.
.. code-block:: bash
pip install sphinx-contributors
#. Add the extension to your Sphinx project ``conf.py`` file.
.. code-block:: python
extensions = ['sphinx_contributors']
Usage
-----
Using the directive:
.. code-block:: rst
.. contributors:: sphinx-doc/sphinx
Renders:
.. image:: https://raw.githubusercontent.com/dgarcia360/sphinx-contributors/master/docs/source/_static/example.png
Check out the full documentation for more customizable options at https://sphinx-contributors.readthedocs.io/
Contributing
------------
We encourage public contributions!
Please review `CONTRIBUTING `_ for details on our code of conduct and development process.
License
-------
Copyright (c) 2018 - present David Garcia (`@dgarcia360 `_).
Licensed under the `MIT License `_.
sphinx-contributors-0.2.7/docs/ 0000775 0000000 0000000 00000000000 14357312640 0016521 5 ustar 00root root 0000000 0000000 sphinx-contributors-0.2.7/docs/Makefile 0000664 0000000 0000000 00000001176 14357312640 0020166 0 ustar 00root root 0000000 0000000 # Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
sphinx-contributors-0.2.7/docs/make.bat 0000664 0000000 0000000 00000001374 14357312640 0020133 0 ustar 00root root 0000000 0000000 @ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd
sphinx-contributors-0.2.7/docs/requirements.txt 0000664 0000000 0000000 00000000031 14357312640 0021777 0 ustar 00root root 0000000 0000000 sphinx-contributors[doc]
sphinx-contributors-0.2.7/docs/source/ 0000775 0000000 0000000 00000000000 14357312640 0020021 5 ustar 00root root 0000000 0000000 sphinx-contributors-0.2.7/docs/source/_static/ 0000775 0000000 0000000 00000000000 14357312640 0021447 5 ustar 00root root 0000000 0000000 sphinx-contributors-0.2.7/docs/source/_static/css/ 0000775 0000000 0000000 00000000000 14357312640 0022237 5 ustar 00root root 0000000 0000000 sphinx-contributors-0.2.7/docs/source/_static/css/custom.css 0000664 0000000 0000000 00000000065 14357312640 0024264 0 ustar 00root root 0000000 0000000 .custom-contributors img {
border-radius: 50%;
}
sphinx-contributors-0.2.7/docs/source/_static/example.png 0000664 0000000 0000000 00000562423 14357312640 0023624 0 ustar 00root root 0000000 0000000 PNG
IHDR
D r} )iCCPICC Profile HT/IHHhH RKJ AŎ,*T,XȢ"@EEY6T$tλsν7ϙ@5-ej d!Ĥd&! - #EE(ʻ |_E˓p @ r%lȇ ]8"q ^7'LQM1&Tmb De bsҡe\r3doͅȪ-S#>V"@DŞKvtxب|qh,gY2sdL|N Y5Wn/'|ihܐ$ 0 @\v`d=¬!w bcQ8'z?:' fX>̦D7sTMPĉ# @'Ɍ y^Ke1ih
f-XCǏ
UŦqش!g$qryAB0n(~L=dS5d5Bdzcm}yp)Ł(/*V &
r@6_`bxvH3<"A#P q^ȇ/#Z{#2 dR(l1~c͂M:#`{x8|戻q}'МIk{?<<#%~p1YBEe{bkyÐ7]n %PMdž{Б' }ә~% G9RqB@Kpﲄ9 |A "A,H`p0,ŠkF >p 4fpA;µ
^> BBhA3qDo$ G$$IG,BJ2d#F~G 'HrBz'C&cQ7
Ccѩh:Ert=ZEE:ډ@1)cܰ ,K016+ʱJkU>D3q[^C8eF|7^¯]x@#l!NA(&vNoH$2DW%3ˈubD"lH^HG*&m %']!u>()+*9*+%+
ʕ(STiF6#{#\,
Nr2<@QXP(BzJ-4卲$e)w)jP)T)u9BM}CidZm9vAbRWPWRj:M@\e^5Z[mZjtuHle{ϫ? ikip54vhxD&