boilerplate for GH Users

esacteksab · esacteksab · commit abc5dfadd4e7 · 2014-01-19T16:43:24.000-08:00
diff --git a/docs/gh/users.rst b/docs/gh/users.rst
@@ -3,15 +3,39 @@ Users
 
 `http://developer.github.com/v3/users/ <http://developer.github.com/v3/users/>`_
 
-.. I'm not sure I like this or if i should use :mod:`users`
+.. toctree::
+    :maxdepth: 1
 
-If you want to manage a user, use the `Users`_ module:
+    users/emails
+    users/followers
+    users/public-keys
 
-.. _Users: ../modules/users.html
 
-but if you want a list of all users in order they signed up to GitHub, use:
+Get a single user
+~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/#get-a-single-user <http://developer.github.com/v3/users/#get-a-single-user>`_
+
+
+Get the authenticated user
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/#get-the-authenticated-user <http://developer.github.com/v3/users/#get-the-authenticated-user>`_
+
+Update the authenticated user
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/#update-the-authenticated-user <http://developer.github.com/v3/users/#update-the-authenticated-user>`_
+
+Get all users
+~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/#get-all-users <http://developer.github.com/v3/users/#get-all-users>`_
+
+
+If you want a list of all users in order they signed up to GitHub, use:
 
-.. similarly to above, perhaps :func:`iter_all_users` would be better suited inline?
 
 .. autofunction:: github3.iter_all_users
+    :noindex:
 
diff --git a/docs/gh/users/emails.rst b/docs/gh/users/emails.rst
@@ -0,0 +1,20 @@
+Emails
+------
+
+`http://developer.github.com/v3/users/emails/ <http://developer.github.com/v3/users/emails/>`_
+
+
+List email addresses for a user
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user <http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user>`_ 
+
+Add email address(es)
+~~~~~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/emails/#add-email-addresses <http://developer.github.com/v3/users/emails/#add-email-addresses>`_
+
+Delete email address(es)
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/emails/#delete-email-addresses <http://developer.github.com/v3/users/emails/#delete-email-addresses>`_
diff --git a/docs/gh/users/followers.rst b/docs/gh/users/followers.rst
@@ -0,0 +1,36 @@
+Followers
+---------
+
+`http://developer.github.com/v3/users/followers/ <http://developer.github.com/v3/users/followers/>`_
+
+
+List followers of a user
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/followers/#list-followers-of-a-user <http://developer.github.com/v3/users/followers/#list-followers-of-a-user>`_
+
+List users followed by another user
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/followers/#list-users-followed-by-another-user <http://developer.github.com/v3/users/followers/#list-users-followed-by-another-user>`_
+
+Check if you are following a user
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user <http://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user>`_
+
+Check if one user follows another
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/followers/#check-if-one-user-follows-another <http://developer.github.com/v3/users/followers/#check-if-one-user-follows-another>`_
+
+Follow a user
+~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/followers/#follow-a-user <http://developer.github.com/v3/users/followers/#follow-a-user>`_
+
+Unfollow a user
+~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/followers/#unfollow-a-user <http://developer.github.com/v3/users/followers/#unfollow-a-user>`_
+
diff --git a/docs/gh/users/public-keys.rst b/docs/gh/users/public-keys.rst
@@ -0,0 +1,36 @@
+Public Keys
+-----------
+
+`http://developer.github.com/v3/users/keys/ <http://developer.github.com/v3/users/keys/>`_
+
+
+List public keys for a user
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/keys/#list-public-keys-for-a-user <http://developer.github.com/v3/users/keys/#list-public-keys-for-a-user>`_
+
+List your public keys
+~~~~~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/keys/#list-your-public-keys <http://developer.github.com/v3/users/keys/#list-your-public-keys>`_
+
+Get a single public key
+~~~~~~~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/keys/#get-a-single-public-key <http://developer.github.com/v3/users/keys/#get-a-single-public-key>`_
+
+Create a public key
+~~~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/keys/#create-a-public-key <http://developer.github.com/v3/users/keys/#create-a-public-key>`_
+
+Update a public key
+~~~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/keys/#update-a-public-key <http://developer.github.com/v3/users/keys/#update-a-public-key>`_
+
+Delete a public key
+~~~~~~~~~~~~~~~~~~~
+
+`http://developer.github.com/v3/users/keys/#delete-a-public-key <http://developer.github.com/v3/users/keys/#delete-a-public-key>`_
+
