Add an index page and relativize a bunch of links for better RTD integration.

f72d7546 · Jason Madden · f86260c2 · f72d7546 · f72d7546 · f72d7546
Commit f72d7546 authored Jul 16, 2015 by Jason Madden
Show whitespace changes
Inline Side-by-side

Showing with 95 additions and 6 deletions

doc/index.rst doc/index.rst +40 -0

doc/intro.rst doc/intro.rst +1 -1

doc/mytheme/layout.html doc/mytheme/layout.html +5 -5

doc/sfc.rst doc/sfc.rst +49 -0

No files found.
--- a/doc/index.rst
+++ b/doc/index.rst
+=================
+ What is gevent?
+=================
+
+gevent is a coroutine_ -based Python_ networking library that uses
+greenlet to provide a high-level synchronous API on top of the libev
+event loop.
+
+Features include:
+
+* **Fast event loop** based on libev (epoll on Linux, kqueue on FreeBSD).
+* **Lightweight execution units** based on greenlet.
+* API that re-uses concepts from the Python standard library (for example there are :class:`gevent.event.Events` and :class:`gevent.queue.Queues`).
+* :doc:`Cooperative sockets with SSL support <networking>`
+* DNS queries performed through threadpool or c-ares.
+* :ref:`Monkey patching utility <monkey-patching>` to get 3rd party modules to become cooperative
+
+
+gevent is `inspired by eventlet
+<http://blog.gevent.org/2010/02/27/why-gevent/>`_ but features more
+consistent API, simpler implementation and better performance. Read
+why others `use gevent
+<http://groups.google.com/group/gevent/browse_thread/thread/4de9703e5dca8271>`_
+and check out the list of the `open source projects based on gevent. <http://code.google.com/p/gevent/wiki/ProjectsUsingGevent>`_
+
+gevent is written and maintained by `Denis Bilenko
+<http://denisbilenko.com/>`_ with help from the `contributors <https://github.com/gevent/gevent/blob/master/AUTHORS#L1>`_ and is licensed under the MIT license.
+
+:ref:`Continue reading <installation>` »
+
+If you like gevent, :doc:`donate <sfc>` to support the development.
+
+.. raw:: html
+
+   <a class="twitter-timeline" data-dnt="true" href="https://twitter.com/search?q=gevent" data-widget-id="621692925999644672">Tweets about gevent</a> <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+"://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+
+
+.. _coroutine: https://en.wikipedia.org/wiki/Coroutine
+.. _Python: http://python.org
+.. _greenlet: http://greenlet.readthedocs.org
--- a/doc/intro.rst
+++ b/doc/intro.rst
@@ -15,6 +15,7 @@ Features include:
 * Subprocess support (through :mod:`gevent.subprocess`)
 * Thread pools

+.. _installation:

 Installation
 ------------
@@ -222,4 +223,3 @@ __ http://sdiehl.github.io/gevent-tutorial/
 .. rubric:: Footnotes

 .. [#f1] This was not the case before 0.13.0, :meth:`kill <Greenlet>` method in 0.12.2 and older was asynchronous by default.
-
--- a/doc/mytheme/layout.html
+++ b/doc/mytheme/layout.html
@@ -180,18 +180,18 @@
 	<div id="header">
 		<div id="top">
 			<div class="left" id="logo">
-                <h1><a id="title" href="/">gevent</a></h1>
+                <h1><a id="title" href="index.html">gevent</a></h1>
 			</div>
 			<div class="left navigation" id="main-nav">
 				<ul class="tabbed">
                    <li><a href="http://blog.gevent.org">Blog</a></li>
                    <li><a href="https://github.com/gevent/gevent">Code</a></li>
-                    <li{%- if pagename!='community' and pagename!='sfc' %} class="current-tab"{%- endif %}><a href="/contents.html">Docs</a></li>
+                    <li{%- if pagename!='community' and pagename!='sfc' and pagename!='index' %} class="current-tab"{%- endif %}><a href="contents.html">Docs</a></li>
                    <li><a href="http://pypi.python.org/pypi/gevent#downloads">Download</a></li>
-					<li{%- if pagename=='community' %} class="current-tab"{%- endif %}><a href="/community.html">Mailing list</a></li>
+					<li{%- if pagename=='community' %} class="current-tab"{%- endif %}><a href="community.html">Mailing list</a></li>
                    <li><a href="https://github.com/gevent/gevent/issues">Issues</a></li>
 					<li><a href="http://webchat.freenode.net/?channels=gevent" rel="nofollow">IRC</a></li>
-                    <li{%- if pagename=='sfc' %} class="current-tab"{%- endif %}><a href="/sfc.html">Donate</a></li>
+                    <li{%- if pagename=='sfc' %} class="current-tab"{%- endif %}><a href="sfc.html">Donate</a></li>
                </ul>
 				<div class="clearer">&nbsp;</div>
 			</div>
@@ -247,7 +247,7 @@

 		<div class="right" id="footer-right">

-			<p class="large"><a href="http://blog.gevent.org">Blog</a> <span class="text-separator">|</span> <a href="https://github.com/gevent/gevent">Code</a> <span class="text-separator">|</span> <a href="/contents.html">Docs</a> <span class="text-separator">|</span> <a href="http://pypi.python.org/pypi/gevent">Download</a> <span class="text-separator">|</span> <a href="/community.html">Mailing list</a> <span class="text-separator">|</span> <a href="https://github.com/gevent/gevent/issues">Issue tracker</a> <span class="text-separator">|</span> <a href="http://webchat.freenode.net/?channels=gevent" rel="nofollow">IRC</a> <span class="text-separator">|</span> <a href="#top" class="quiet">Page Top &uarr;</a></p>
+			<p class="large"><a href="http://blog.gevent.org">Blog</a> <span class="text-separator">|</span> <a href="https://github.com/gevent/gevent">Code</a> <span class="text-separator">|</span> <a href="contents.html">Docs</a> <span class="text-separator">|</span> <a href="http://pypi.python.org/pypi/gevent">Download</a> <span class="text-separator">|</span> <a href="community.html">Mailing list</a> <span class="text-separator">|</span> <a href="https://github.com/gevent/gevent/issues">Issue tracker</a> <span class="text-separator">|</span> <a href="http://webchat.freenode.net/?channels=gevent" rel="nofollow">IRC</a> <span class="text-separator">|</span> <a href="#top" class="quiet">Page Top &uarr;</a></p>

 		</div>


--- a/doc/sfc.rst
+++ b/doc/sfc.rst
+.. raw:: html
+
+		 <div class="section" id="donate">
+		 <h1>Donate<a class="headerlink" href="#donate" title="Permalink to this headline">¶</a></h1>
+		 <p></p><p>Gevent is a member project of the <a href="http://sfconservancy.org">Software Freedom Conservancy</a>. The SFC is a not-for-profit organization that provides financial and administrative assistance to open source projects.</p>
+		 <table>
+		 <tbody><tr>
+         <td><b>Donate with PayPal</b></td>
+		 </tr>
+		 <tr>
+		 <td>
+
+		 <form action="https://www.paypal.com/cgi-bin/webscr" method="post">
+		 <input type="hidden" name="cmd" value="_s-xclick">
+		 <input type="hidden" name="hosted_button_id" value="WWTKXX5YS5GSU">
+
+		 <input type="image" src="https://www.paypal.com/en_US/i/btn/btn_donateCC_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!">
+		 <img alt="" border="0" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="0" height="0" style="display: none !important; visibility: hidden !important; opacity: 0 !important; background-position: 1px 1px;">
+		 </form>
+
+		 </td>
+		 </tr>
+
+		 </tbody></table>
+
+		 <b>Donations by check</b>
+		 <p>
+		 We can also accept donations drawn in USD from banks in the USA (donations from banks outside of the US or not in USD should be handled by wire).
+
+		 Make checks payable to "Software Freedom Conservancy, Inc." and place "Directed donation: Gevent" in the memo field. Checks should be mailed to:
+		 </p>
+
+		 <pre style="background: white; border: 0px;">Software Freedom Conservancy, Inc.
+		 137 Montague ST  STE 380
+		 BROOKLYN, NY 11201
+		 USA
+		 </pre>
+		 <p>
+		 The SFC can accept wire donations, but the instructions vary depending on the country of origin. Please contact accounting@sfconservancy.org for instructions.</p>
+		 <p></p>
+		 </div>
+
+
+
+         </div>
+         </div>
+         </div>
+         </div>
+         </div>