Skip to content

Commit

Permalink
Update documentation and docs domain (#73)
Browse files Browse the repository at this point in the history
* Update documentation and docs domain

* Add changelog fragment
  • Loading branch information
vivekjoshy committed Dec 3, 2022
1 parent 4302ab9 commit 1476294
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) ![GitHub contributors (via allcontributors.org)](https://img.shields.io/github/all-contributors/OpenDebates/openskill.py?label=contributors)
[![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)

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

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

## Advanced Usage
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).
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).


## Implementations in other Languages
Expand Down
1 change: 1 addition & 0 deletions changes/73.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add more details to the documentation, fixes broken links and point a custom domain name to the docs.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
html_title = "OpenSkill for Python"

# OGP Config
ogp_site_url = "https://openskillpy.readthedocs.io/en/stable/"
ogp_site_url = "https://openskill.me/en/stable/"
ogp_site_name = "OpenSkill for Python"
ogp_image = "https://i.imgur.com/tSTFzZY.gif"
ogp_description_length = 300
Expand Down
10 changes: 8 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
name = openskill
version = attr: openskill.__version__
description = A faster, open-license alternative to Microsoft TrueSkill
author = Taven <taven@outlook.in>
author_email = contact@taven.me
author = Taven <taven@opendebates.net>
author_email = taven@opendebates.net
license = mit
license_files = LICENSE
url = https://github.com/OpenDebates/openskill.py
Expand All @@ -26,6 +26,12 @@ keywords =
trueskill
bayesian
rating
project_urls =
Documentation = https://openskill.me/en/stable
Release notes = https://github.com/OpenDebates/openskill.py/blob/main/CHANGELOG.rst
Funding = https://github.com/sponsors/OpenDebates
Source = https://github.com/OpenDebates/openskill.py
Tracker = https://github.com/OpenDebates/openskill.py/issues

[options]
packages = find:
Expand Down

0 comments on commit 1476294

Please sign in to comment.