Skip to content

Commit 34eaece

Browse files
committed
Add basic sphinx docs for pagination
1 parent 775ebef commit 34eaece

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

docs/Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ html:
4141
@echo
4242
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
4343

44+
livehtml:
45+
sphinx-autobuild -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
46+
4447
dirhtml:
4548
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
4649
@echo

docs/source/index.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,17 @@ individual clients:
5858
services/openstates.rst
5959
services/capitolwords.rst
6060

61+
Extras
62+
======
63+
64+
Useful utilities for working with the services.
65+
66+
.. toctree::
67+
:maxdepth 2
68+
69+
sunlight/cache.rst
70+
sunlight/pagination.rst
71+
6172
Internals
6273
=========
6374

docs/source/sunlight/pagination.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
sunlight.pagination
2+
===============
3+
4+
This module provides a pagination wrapper for services that support it. Currently only :doc:`/services/congress` supports this.
5+
6+
Methods and Constants
7+
*********************
8+
9+
.. automodule:: sunlight.pagination
10+
:members:
11+

0 commit comments

Comments
 (0)