Skip to content

Commit

Permalink
Updated links after repo transfer
Browse files Browse the repository at this point in the history
  • Loading branch information
@Simon-Rey
Simon-Rey committed Nov 13, 2024
1 parent 1ecc091 commit b71806b
Show file tree
Hide file tree
Showing 146 changed files with 7,749 additions and 7,195 deletions.
16 changes: 9 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Pabutools: PB as easy as [ABC](https://github.com/martinlackner/abcvoting)

[![PyPI Status](https://img.shields.io/pypi/v/pabutools.svg)](https://pypi.python.org/pypi/pabutools)
[![Build badge](https://github.com/pbvoting/pabutools/workflows/build/badge.svg?branch=main)](https://github.com/pbvoting/pabutools/actions/workflows/build.yml)
[![codecov](https://codecov.io/gh/pbvoting/pabutools/branch/main/graphs/badge.svg)](https://codecov.io/gh/pbvoting/pabutools/tree/main)
[![Build badge](https://github.com/comsoc-community/pabutools/workflows/build/badge.svg?branch=main)](https://github.com/comsoc-community/pabutools/actions/workflows/build.yml)
[![codecov](https://codecov.io/gh/comsoc-community/pabutools/branch/main/graphs/badge.svg)](https://codecov.io/gh/comsoc-community/pabutools/tree/main)

## Overview

Expand Down Expand Up @@ -31,12 +31,12 @@ pip3 install pabutools

## Documentation

The complete documentation is available [here](https://pbvoting.github.io/pabutools/).
The complete documentation is available [here](https://comsoc-community.github.io/pabutools/).
It includes
* [installation instructions](https://pbvoting.github.io/pabutools/installation.html),
* a [short guide](https://pbvoting.github.io/pabutools/quickstart.html) for a quick start,
* a [complete guide](https://pbvoting.github.io/pabutools/usage/index.html) for more advanced usage, and
* a [reference guide](https://pbvoting.github.io/pabutools/reference/index.html) to get all the details.
* [installation instructions](https://comsoc-community.github.io/pabutools/installation.html),
* a [short guide](https://comsoc-community.github.io/pabutools/quickstart.html) for a quick start,
* a [complete guide](https://comsoc-community.github.io/pabutools/usage/index.html) for more advanced usage, and
* a [reference guide](https://comsoc-community.github.io/pabutools/reference/index.html) to get all the details.

## Development

Expand Down Expand Up @@ -66,6 +66,7 @@ make html
This will generate the documentation locally (in the folder `docs-source/build`). If you want the documentation
to also be updated when pushing, run:
```shell
make githubclean
make github
```

Expand All @@ -76,3 +77,4 @@ This means that if you create new class of functions that should appear in the d
to add they yourself using to autodoc directives (take inspiration from the files in `docs-source/source`).

If you want to help, check the `todos.txt` file, several todos are described there.

2 changes: 1 addition & 1 deletion docs-source/source/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@

html_title = "Pabutools"
html_theme_options = {
"repository_url": "https://github.com/pbvoting/pabutools",
"repository_url": "https://github.com/COMSOC-Community/pabutools",
"use_repository_button": True,
}
html_context = {"default_mode": "light"}
2 changes: 1 addition & 1 deletion docs-source/source/installation.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ installation should be as easy as:
pip3 install pabutools
You can also directly download the sources from our
`GitHub repository <https://github.com/pbvoting/pabutools>`_ if that seems easier to you.
`GitHub repository <https://github.com/COMSOC-Community/pabutools>`_ if that seems easier to you.
162 changes: 86 additions & 76 deletions docs/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!DOCTYPE html>


<html lang="en" data-theme="light">
<html lang="en" data-content_root="../" data-theme="light">

<head>
<meta charset="utf-8" />
Expand All @@ -15,83 +15,91 @@
document.documentElement.dataset.mode = localStorage.getItem("mode") || "light";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>

<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="../_static/styles/bootstrap.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=e353d410970836974a52" rel="stylesheet" />
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }

</style>
</noscript>

<link href="../_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=e353d410970836974a52" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=26a4bc78f4c0ddb94549" rel="stylesheet" />

<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b76e3c8a" />
<link rel="stylesheet" href="../_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/styles/sphinx-book-theme.css?v=a3416100" />

<!-- So that users can add custom icons -->
<script src="../_static/scripts/fontawesome.js?digest=26a4bc78f4c0ddb94549"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549" />

<script src="../_static/documentation_options.js?v=2f00bfe7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/documentation_options.js?v=61547a20"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></script>
<script src="../_static/scripts/sphinx-book-theme.js?v=887ef09a"></script>
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/index';</script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="1.1.9" />
</head>


<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="light">



<a class="skip-link" href="#main-content">Skip to main content</a>
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>

<input type="checkbox"
class="sidebar-toggle"
name="__primary"
id="__primary"/>
<label class="overlay overlay-primary" for="__primary"></label>
<div id="pst-scroll-pixel-helper"></div>

<input type="checkbox"
class="sidebar-toggle"
name="__secondary"
id="__secondary"/>
<label class="overlay overlay-secondary" for="__secondary"></label>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>


<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<dialog id="pst-search-dialog">

<form class="bd-search d-flex align-items-center"
action="../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search..."
aria-label="Search..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
</form>
</dialog>

<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>


<nav class="bd-header navbar navbar-expand-lg bd-navbar">
</nav>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
</header>


<div class="bd-container">
<div class="bd-container__inner bd-page-width">

<div class="bd-sidebar-primary bd-sidebar">




<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">



Expand All @@ -104,6 +112,9 @@

<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">





<a class="navbar-brand logo" href="../index.html">
Expand All @@ -112,16 +123,24 @@




<p class="title logo__title">Pabutools</p>

</a></div>
<div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
<div class="sidebar-primary-item">

<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button></div>
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Pabutools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quickstart.html">Quick Start</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../usage/index.html">Complete Guide</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../usage/index.html">Complete Guide</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="../usage/instances.html">Instances</a></li>
<li class="toctree-l2"><a class="reference internal" href="../usage/profiles.html">Profiles</a></li>
<li class="toctree-l2"><a class="reference internal" href="../usage/libraries.html">Preference Libraries</a></li>
Expand All @@ -132,24 +151,24 @@
<li class="toctree-l2"><a class="reference internal" href="../usage/tiebreaking.html">Tie-Breaking</a></li>
<li class="toctree-l2"><a class="reference internal" href="../usage/fractions.html">Fractions</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../reference/index.html">Reference</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="../reference/election/index.html">Election module</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../reference/index.html">Reference</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="../reference/election/index.html">Election module</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/election/instance.html">Instance</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/election/ballot.html">Ballot</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/election/profile.html">Profile</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/election/satisfaction.html">Satisfaction</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/election/libraries.html">Preference Libraries</a></li>
</ul>
</li>
</details></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/rules/index.html">Rules module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/analysis/index.html">Analysis module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/visualisation/index.html">Visualisation Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/tiebreaking.html">Tie-Breaking</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/fractions.html">Fractions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/utils.html">Utils</a></li>
</ul>
</li>
</details></li>
</ul>

</div>
Expand All @@ -165,7 +184,7 @@

</div>

<main id="main-content" class="bd-main">
<main id="main-content" class="bd-main" role="main">



Expand All @@ -174,14 +193,14 @@
<div class="bd-content">
<div class="bd-article-container">

<div class="bd-header-article">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">

<div class="header-article-items__start">

<div class="header-article-item"><label class="sidebar-toggle primary-toggle btn btn-sm" for="__primary" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<div class="header-article-item"><button class="sidebar-toggle primary-toggle btn btn-sm" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-bars"></span>
</label></div>
</button></div>

</div>

Expand All @@ -193,7 +212,7 @@
<div class="article-header-buttons">


<a href="https://github.com/pbvoting/pabutools" target="_blank"
<a href="https://github.com/COMSOC-Community/pabutools" target="_blank"
class="btn btn-sm btn-source-repository-button"
title="Source repository"
data-bs-placement="bottom" data-bs-toggle="tooltip"
Expand Down Expand Up @@ -223,23 +242,17 @@
</button>


<script>
document.write(`
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
</button>
`);
</script>

<script>
document.write(`
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
`);
</script>

<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button>


<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>

</div></div>

Expand All @@ -263,7 +276,7 @@ <h1></h1>


<div id="searchbox"></div>
<article class="bd-article" role="main">
<article class="bd-article">

<h1>All modules for which code is available</h1>
<ul><li><a href="pabutools/analysis/category.html">pabutools.analysis.category</a></li>
Expand Down Expand Up @@ -311,16 +324,12 @@ <h1>All modules for which code is available</h1>



<footer class="bd-footer-article">


<footer class="prev-next-footer d-print-none">

<div class="footer-article-items footer-article__inner">

<div class="footer-article-item"><!-- Previous / next buttons -->
<div class="prev-next-area">
</div></div>

</div>

</footer>

</div>
Expand All @@ -343,6 +352,7 @@ <h1>All modules for which code is available</h1>

<div class="footer-item">


<p class="copyright">

© Copyright 2023, Simon Rey, Grzegorz Pierczyński, Markus Utke and Piotr Skowron.
Expand All @@ -369,8 +379,8 @@ <h1>All modules for which code is available</h1>
</div>

<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="../_static/scripts/bootstrap.js?digest=e353d410970836974a52"></script>
<script src="../_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52"></script>
<script defer src="../_static/scripts/bootstrap.js?digest=26a4bc78f4c0ddb94549"></script>
<script defer src="../_static/scripts/pydata-sphinx-theme.js?digest=26a4bc78f4c0ddb94549"></script>

<footer class="bd-footer">
</footer>
Expand Down
Loading

0 comments on commit b71806b

Please sign in to comment.