docs

docs/source/conf.py

@@ -1,6 +1,15 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
+import os
+import sys
+
+import django
+
+sys.path.insert(0, os.path.abspath('../..'))
+
+os.environ['DJANGO_SETTINGS_MODULE'] = 'example.exampleapp.settings'
+django.setup()
 
 # -- General configuration ------------------------------------------------
 

docs/source/index.rst

@@ -9,6 +9,7 @@ Welcome to django-politico-civic-vote's documentation!
 
    Why this? <why>
    Quickstart <quickstart>
+   Models <models>
 
 
 

docs/source/models.rst

@@ -0,0 +1,11 @@
+Models
+======
+
+.. automodule:: vote.models.delegates
+  :members:
+
+.. automodule:: vote.models.electoral_votes
+  :members:
+
+.. automodule:: vote.models.votes
+  :members:

example/Pipfile

@@ -21,6 +21,8 @@ geography = {git = "ssh://git@github.com/The-Politico/politico-civic-geography",
 government = {git = "ssh://git@github.com/The-Politico/politico-civic-government", editable = true}
 election = {git = "ssh://git@github.com/The-Politico/politico-civic-election", editable = true}
 "vote" = {path = "./..", editable = true}
-
+"sphinx" = "*"
+"sphinx_rtd_theme" = "*"
+"sphinxcontrib-django" = "*"
 
 [dev-packages]

vote/models/votes.py

@@ -5,7 +5,7 @@
 
 
 class Votes(BaseResult):
-    """Popular vote results."""
+    """Popular votes."""
     candidate_election = models.ForeignKey(
         CandidateElection,
         null=True, blank=True, related_name="votes",