Merge pull request #126 from cdonnay/user_guide

Update to read the docs
mggg · Jun 5, 2024 · 2b9deb3 · 2b9deb3
2 parents f9bc0f3 + 910bdba
commit 2b9deb3
Show file tree

Hide file tree

Showing 118 changed files with 781,800 additions and 5,384 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,5 @@ dist/
 .idea
 extra_data/
 .venv
+.docs_venv
+docs/_build
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,12 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ## Added
+- Created a read the docs page.
+- Add `scale` parameter to `ballot_graph.draw()` to allow for easier reading of text labels.
 
 ## Changed
-- Dirichlet parameter tutorial notebook now uses slate-PlackettLuce.
+- Updated tutorial notebooks; larger focus on slate models, updated notebooks to match current codebase.
+- Removed the seq-RCV transfer rule since it is a dummy function, replaced with lambda function.
+- Update plot MDS to have aspect ratio 1, remove axes labels since they are meaningless in MDS.
 
 ## Fixed
-- fixed bug by which slate-PlackettLuce could not generate ballots when some candidate had 0 support.
+- Fixed bug by which slate-PlackettLuce could not generate ballots when some candidate had 0 support.
+- Updated various functions in the ballot generator module to only generate ballots for non-zero candidates.
+- Fixed one bloc s-BT pdf, which was incorrectly giving 0 weight to all ballot types.
 
 ## [2.0.0] - 2024-03-04
 

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 ## VoteKit
 
-`VoteKit` ia a Swiss army knife for computational social choice research.
+`VoteKit` is a Swiss army knife for computational social choice research.
 
 **Helpful links:** [Source Repository](https://github.com/mggg/VoteKit) | [Documentation](https://mggg.github.io/VoteKit/) | [Issues](https://github.com/mggg/VoteKit/issues) | [MGGG.org](https://mggg.org/)
 

diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/SCR_ballot_generators.md b/docs/SCR_ballot_generators.md
diff --git a/docs/SCR_distances.md b/docs/SCR_distances.md
diff --git a/docs/SCR_elections.md b/docs/SCR_elections.md
diff --git a/docs/SCR_general_vocabulary.md b/docs/SCR_general_vocabulary.md
diff --git a/docs/SCR_preference_intervals.md b/docs/SCR_preference_intervals.md