8000 Start a branch for updating the docs · danpalmer/github3.py@89ad0e5 · GitHub
[go: up one dir, main page]

Skip to content

Commit 89ad0e5

Browse files
committed
Start a branch for updating the docs
1 parent e493f8e commit 89ad0e5

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

docs/index.rst

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ Let's get information about a user::
4141
More Examples
4242
~~~~~~~~~~~~~
4343

44+
.. note::
45+
46+
We would love for you to submit more examples to the documentation. Just
47+
send a `pull request <https://github.com/sigmavirus24/github3.py>`_!
48+
4449
.. toctree::
4550
:maxdepth: 2
4651

@@ -55,13 +60,23 @@ More Examples
5560
examples/octocat
5661

5762

63+
In depth documentation
64+
----------------------
65+
66+
Organized using GitHub's documentation
67+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
68+
69+
.. one-to-one correspondence with developer.github.com/v3
70+
5871
.. links
5972
6073
.. _GitHub API: http://developer.github.com
6174

6275

6376
Modules
64-
-------
77+
~~~~~~~
78+
79+
.. TODO: Move these to modules/*.rst
6580
6681
.. toctree::
6782
:maxdepth: 1

0 commit comments

Comments
 (0)
0