Skip to content

Commit

Permalink
Docs and new version
Browse files Browse the repository at this point in the history
  • Loading branch information
@Simon-Rey
Simon-Rey committed Mar 27, 2024
1 parent 53e47ca commit 4b198f3
Show file tree
Hide file tree
Showing 61 changed files with 1,320 additions and 9,997 deletions.
2 changes: 1 addition & 1 deletion docs-source/source/reference/analysis/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ Analysis module
.. automodule:: pabutools.analysis.category
:members:

.. automodule:: pabutools.analysis.projectloss
.. automodule:: pabutools.analysis.mesanalytics
:members:
1,902 changes: 0 additions & 1,902 deletions docs/_modules/collections.html
View file

This file was deleted.

2 changes: 1 addition & 1 deletion docs/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -266,8 +266,8 @@ <h1></h1>
<h1>All modules for which code is available</h1>
<ul><li><a href="pabutools/analysis/category.html">pabutools.analysis.category</a></li>
<li><a href="pabutools/analysis/instanceproperties.html">pabutools.analysis.instanceproperties</a></li>
<li><a href="pabutools/analysis/mesanalytics.html">pabutools.analysis.mesanalytics</a></li>
<li><a href="pabutools/analysis/profileproperties.html">pabutools.analysis.profileproperties</a></li>
<li><a href="pabutools/analysis/projectloss.html">pabutools.analysis.projectloss</a></li>
<li><a href="pabutools/analysis/votersatisfaction.html">pabutools.analysis.votersatisfaction</a></li>
<li><a href="pabutools/election/ballot/approvalballot.html">pabutools.election.ballot.approvalballot</a></li>
<li><a href="pabutools/election/ballot/ballot.html">pabutools.election.ballot.ballot</a></li>
Expand Down
110 changes: 46 additions & 64 deletions docs/_modules/pabutools/analysis/category.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-content_root="../../../" data-theme="light">
<html lang="en" data-theme="light">

<head>
<meta charset="utf-8" />
Expand All @@ -17,28 +17,27 @@
</script>

<!-- Loaded before other Sphinx assets -->
<link href="../../../_static/styles/theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" />
<link href="../../../_static/styles/bootstrap.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" />
<link href="../../../_static/styles/pydata-sphinx-theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" />
<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" />


<link href="../../../_static/vendor/fontawesome/6.5.1/css/all.min.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../_static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../_static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2" />
<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" />

<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=384b581d" />
<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" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae" />
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" />
<script src="../../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script>
<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" />

<script src="../../../_static/documentation_options.js?v=3c867bb8"></script>
<script src="../../../_static/documentation_options.js?v=951a251d"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/scripts/sphinx-book-theme.js?v=efea14e4"></script>
<script src="../../../_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></script>
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/pabutools/analysis/category';</script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
Expand All @@ -51,15 +50,7 @@



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

<div id="pst-scroll-pixel-helper"></div>

<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>
Back to top
</button>

<a class="skip-link" href="#main-content">Skip to main content</a>

<input type="checkbox"
class="sidebar-toggle"
Expand Down Expand Up @@ -94,17 +85,12 @@
</form></div>
</div>

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


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





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


Expand All @@ -118,7 +104,6 @@

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



<a class="navbar-brand logo" href="../../../index.html">
Expand All @@ -127,30 +112,28 @@




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

</a></div>
<div class="sidebar-primary-item">

<script>
document.write(`
<button class="btn navbar-btn search-button-field search-button__button" 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>
`);
</script></div>
<div class="sidebar-primary-item"><nav class="bd-links bd-docs-nav" aria-label="Main">
<div class="sidebar-primary-item"><nav class="bd-links" id="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"><a class="reference internal" href="../../../usage.html">Complete Guide</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../reference/index.html">Reference</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-l2 has-children"><a class="reference internal" href="../../../reference/election/index.html">Election module</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-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-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>
<li class="toctree-l2"><a class="reference internal" href="../../../usage/satisfaction.html">Satisfaction Measures</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../usage/rules.html">Rules</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../usage/outcomevisualisation.html">Outcome Visualisation</a></li>
<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>
<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>
Expand Down Expand Up @@ -238,22 +221,20 @@
</button>



<script>
document.write(`
<button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span>
<span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span>
<span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span>
<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 fa-lg"></i>
<i class="fa-solid fa-magnifying-glass"></i>
</button>
`);
</script>
Expand All @@ -280,7 +261,7 @@ <h1></h1>


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

<h1>Source code for pabutools.analysis.category</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">collections.abc</span> <span class="kn">import</span> <span class="n">Collection</span>
Expand Down Expand Up @@ -384,20 +365,22 @@ <h1>Source code for pabutools.analysis.category</h1><div class="highlight"><pre>





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

<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>



<div class="bd-sidebar-secondary bd-toc"></div>


</div>
<footer class="bd-footer-content">
Expand All @@ -414,7 +397,6 @@ <h1>Source code for pabutools.analysis.category</h1><div class="highlight"><pre>

<div class="footer-item">


<p class="copyright">

© Copyright 2023, Simon Rey, Grzegorz Pierczyński, Markus Utke and Piotr Skowron.
Expand All @@ -441,8 +423,8 @@ <h1>Source code for pabutools.analysis.category</h1><div class="highlight"><pre>
</div>

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

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

0 comments on commit 4b198f3

Please sign in to comment.