add proportional methods to docs

Author: epacuit

docs/source/conf.py

@@ -18,7 +18,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'pref_voting'
-copyright = '2024, Wes Holliday and Eric Pacuit'
+copyright = '2025, Wes Holliday and Eric Pacuit'
 author = 'Wes Holliday and Eric Pacuit'
 
 # The full version, including alpha/beta/rc tags

docs/source/index.rst

@@ -106,6 +106,7 @@ Contents
    margin_based_methods
    combined_methods
    other_methods
+   proportional_methods
    probabilistic_methods
    stochastic_methods
    utility_methods

pref_voting/iterative_methods.py

@@ -90,13 +90,13 @@ def _instant_runoff_for_truncated_linear_orders(profile, curr_cands = None, thre
         from pref_voting.profiles_with_ties import ProfileWithTies
         from pref_voting.iterative_methods import instant_runoff_for_truncated_linear_orders
 
-        prof = ProfileWithTies([{0:1, 1:1},{0:1, 1:2, 2:3, 3:4}, {0:1, 1:3, 2:3}, {3:2}, {0:1}, {0:1}, {}, {}])
-        prof.display()
+        prof = ProfileWithTies([{0:1, 1:1},{0:1, 1:2, 2:3, 3:4}, {0:1, 1:3, 2:3}, {3:2}, {0:1}, {0:1}])
+        # prof.display()
 
         tprof, report = prof.truncate_overvotes()
         for r, new_r, count in report: 
             print(f"{r} --> {new_r}: {count}")
-        tprof.display()
+        # tprof.display()
         instant_runoff_for_truncated_linear_orders.display(tprof)
     
     
@@ -514,13 +514,13 @@ def instant_runoff_for_truncated_linear_orders(profile, curr_cands = None, thres
         from pref_voting.profiles_with_ties import ProfileWithTies
         from pref_voting.iterative_methods import instant_runoff_for_truncated_linear_orders
 
-        prof = ProfileWithTies([{0:1, 1:1},{0:1, 1:2, 2:3, 3:4}, {0:1, 1:3, 2:3}, {3:2}, {0:1}, {0:1}, {}, {}])
-        prof.display()
+        prof = ProfileWithTies([{0:1, 1:1},{0:1, 1:2, 2:3, 3:4}, {0:1, 1:3, 2:3}, {3:2}, {0:1}, {0:1}])
+        # prof.display()
 
         tprof, report = prof.truncate_overvotes()
         for r, new_r, count in report: 
             print(f"{r} --> {new_r}: {count}")
-        tprof.display()
+        # tprof.display()
         instant_runoff_for_truncated_linear_orders.display(tprof)