Add ability to add all contributors

vivekjoshy · Dec 2, 2022 · 76ff3a1 · 76ff3a1
1 parent 142fddb
commit 76ff3a1
Show file tree

Hide file tree

Showing 13 changed files with 65 additions and 11 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -0,0 +1,16 @@
+{
+  "projectName": "openskill.py",
+  "projectOwner": "daegontaven",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": ["CONTRIBUTORS.md"],
+  "imageSize": 100,
+  "commit": false,
+  "contributorsPerLine": 7,
+  "contributorsSortAlphabetically": false,
+  "badgeTemplate": "![GitHub contributors (via allcontributors.org)](https://img.shields.io/github/all-contributors/OpenDebates/openskill.py?label=Contributors)",
+  "contributorTemplate": "<a href=\"<%= contributor.profile %>\"><img src=\"<%= contributor.avatar_url %>\" width=\"<%= options.imageSize %>px;\" alt=\"\"/><br /><sub><b><%= contributor.name %></b></sub></a>",
+  "linkToUsage": true,
+  "skipCi": true,
+  "contributors": []
+}
diff --git a/AUTHORS.rst b/AUTHORS.rst
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -0,0 +1,10 @@
+# Contributors
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 ![](https://i.imgur.com/tSTFzZY.gif)
 
 
-[![Tests](https://github.com/OpenDebates/openskill.py/actions/workflows/main.yml/badge.svg)](https://github.com/OpenDebates/openskill.py/actions/workflows/main.yml) [![codecov](https://codecov.io/gh/OpenDebates/openskill.py/branch/main/graph/badge.svg?token=Ep07QEelsi)](https://codecov.io/gh/OpenDebates/openskill.py) ![PyPI - Downloads](https://img.shields.io/pypi/dm/openskill) [![Documentation Status](https://readthedocs.org/projects/openskillpy/badge/?version=latest)](https://openskillpy.readthedocs.io/en/latest/?badge=latest) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/openskill)
+[![Tests](https://github.com/OpenDebates/openskill.py/actions/workflows/main.yml/badge.svg)](https://github.com/OpenDebates/openskill.py/actions/workflows/main.yml) [![codecov](https://codecov.io/gh/OpenDebates/openskill.py/branch/main/graph/badge.svg?token=Ep07QEelsi)](https://codecov.io/gh/OpenDebates/openskill.py) ![PyPI - Downloads](https://img.shields.io/pypi/dm/openskill) [![Documentation Status](https://readthedocs.org/projects/openskillpy/badge/?version=latest)](https://openskillpy.readthedocs.io/en/latest/?badge=latest) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/openskill) ![GitHub contributors (via allcontributors.org)](https://img.shields.io/github/all-contributors/OpenDebates/openskill.py?label=contributors)
 
 [![Anaconda-Server Badge](https://anaconda.org/conda-forge/openskill/badges/version.svg)](https://anaconda.org/conda-forge/openskill)
 

diff --git a/docs/_static/logo-light.gif b/docs/_static/logo-light.gif
diff --git a/docs/_static/logo.gif b/docs/_static/logo.gif
diff --git a/docs/authors.rst b/docs/authors.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -81,6 +81,8 @@
     "sphinx.ext.ifconfig",
     "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
+    "sphinxext.opengraph",
+    "myst_parser",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -103,6 +105,22 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
+html_theme_options = {
+    "light_logo": "logo-light.gif",
+    "dark_logo": "logo.gif",
+    "source_repository": "https://github.com/OpenDebates/openskill.py/",
+    "source_branch": "main",
+    "source_directory": "docs/",
+}
+html_title = "OpenSkill for Python"
+
+# OGP Config
+ogp_site_url = "https://openskillpy.readthedocs.io/en/stable/"
+ogp_site_name = "OpenSkill for Python"
+ogp_image = "https://i.imgur.com/tSTFzZY.gif"
+ogp_description_length = 300
+ogp_type = "website"
+ogp_enable_meta_description = True
 
 python_version = ".".join(map(str, sys.version_info[0:2]))
 intersphinx_mapping = {

diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -46,3 +46,8 @@ You are also responsible for writing tests(where applicable) if you are contribu
 accept the PR until you write a test for that area of code. Tests ensure long term stability.
 
 Also note that there are CI checks in place. If any automated tests fail, please rework and resubmit your PR.
+
+Credit Yourself
+---------------
+
+Remember to follow this `guide <https://allcontributors.org/docs/en/bot/usage>`_ to add yourself to the list of `contributors <contributors>`_.
diff --git a/docs/contributors.rst b/docs/contributors.rst
@@ -0,0 +1,4 @@
+.. _contributors:
+
+.. include:: ../CONTRIBUTORS.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,11 +1,15 @@
+:og:description: openskill.py is an n-player, n-team skill rating system with the ability to predict match outcomes (like win and draw) with upto 90% accuracy given enough data.
+:og:image: https://i.imgur.com/tSTFzZY.gif
+:og:image:alt: OpenSkill for Python
+
+
 :hide-toc:
 
 ============
 openskill.py
 ============
 
-This is the documentation of **openskill** for python.
-
+This is the documentation of **openskill** for python. It is an n-player, n-team skill rating system with the ability to predict match outcomes (like win and draw) with upto 90% accuracy given enough data.
 
 Contents
 ========
@@ -14,7 +18,7 @@ Contents
    :maxdepth: 2
 
    License <license>
-   Authors <authors>
+   Contributors <contributors>
    Contribution Guidelines <contributing>
    Installation <installation>
    User Manual <manual>

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,4 @@
 Sphinx
 furo
+myst-parser
+sphinxext-opengraph
diff --git a/setup.cfg b/setup.cfg
@@ -38,6 +38,8 @@ docs =
 	Sphinx
 	furo
     Pygments
+    myst-parser
+    sphinxext-opengraph
 tests =
 	pytest
 	pytest-cov