Skip to content

Commit 1476294

Browse files
authored
Update documentation and docs domain (#73)
* Update documentation and docs domain * Add changelog fragment
1 parent 4302ab9 commit 1476294

File tree

4 files changed

+12
-5
lines changed

4 files changed

+12
-5
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
![](https://i.imgur.com/tSTFzZY.gif)
33

44

5-
[![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)
5+
[![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://openskill.me/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)
66

77
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/openskill/badges/version.svg)](https://anaconda.org/conda-forge/openskill)
88

@@ -136,7 +136,7 @@ The default model is `PlackettLuce`. You can import alternate models from `opens
136136
- Plackett-Luce (**default**) is a generalized Bradley-Terry model for k ≥ 3 teams. It scales best.
137137

138138
## Advanced Usage
139-
You can learn more about how to configure this library to suit your custom needs in the [project documentation](https://openskillpy.readthedocs.io/en/stable/advanced.html).
139+
You can learn more about how to configure this library to suit your custom needs in the [project documentation](https://openskill.me/en/stable/advanced.html).
140140

141141

142142
## Implementations in other Languages

changes/73.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add more details to the documentation, fixes broken links and point a custom domain name to the docs.

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@
115115
html_title = "OpenSkill for Python"
116116

117117
# OGP Config
118-
ogp_site_url = "https://openskillpy.readthedocs.io/en/stable/"
118+
ogp_site_url = "https://openskill.me/en/stable/"
119119
ogp_site_name = "OpenSkill for Python"
120120
ogp_image = "https://i.imgur.com/tSTFzZY.gif"
121121
ogp_description_length = 300

setup.cfg

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
name = openskill
33
version = attr: openskill.__version__
44
description = A faster, open-license alternative to Microsoft TrueSkill
5-
author = Taven <taven@outlook.in>
6-
author_email = contact@taven.me
5+
author = Taven <taven@opendebates.net>
6+
author_email = taven@opendebates.net
77
license = mit
88
license_files = LICENSE
99
url = https://github.com/OpenDebates/openskill.py
@@ -26,6 +26,12 @@ keywords =
2626
trueskill
2727
bayesian
2828
rating
29+
project_urls =
30+
Documentation = https://openskill.me/en/stable
31+
Release notes = https://github.com/OpenDebates/openskill.py/blob/main/CHANGELOG.rst
32+
Funding = https://github.com/sponsors/OpenDebates
33+
Source = https://github.com/OpenDebates/openskill.py
34+
Tracker = https://github.com/OpenDebates/openskill.py/issues
2935

3036
[options]
3137
packages = find:

0 commit comments

Comments
 (0)