Skip to content

P
pygeoip
Commit 73450789 by William Tisäter
Options

First draft of the Sphinx index page

parent 6cee841a
Showing with 428 additions and 193 deletions
docs/_build/html/.buildinfo
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 320ed978aa5f2fa4fcd3fc33184d60b3
config: ed5d125bb7e508173539a06d67c0fa60
tags: 645f666f9bcd5a90fca523b33c5a78b7
docs/_build/html/_sources/index.txt
.. pygeoip documentation master file, created by
sphinx-quickstart on Thu Nov 14 10:52:22 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
====================================================
Pure Python API for Maxmind's binary GeoIP databases
====================================================
Welcome to pygeoip's documentation!
===================================
.. currentmodule:: pygeoip
Contents:
Work in progress!
.. toctree::
:maxdepth: 2
:class:`GeoIP` methods
----------------------
.. automethod:: GeoIP.__init__
Country lookup
''''''''''''''
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. automethod:: GeoIP.country_code_by_addr
.. automethod:: GeoIP.country_code_by_name
.. toctree
\ No newline at end of file
docs/_build/html/_static/nature.css → docs/_build/html/_static/default.css
/*
* nature.css_t
* ~~~~~~~~~~~~
* default.css_t
* ~~~~~~~~~~~~~
*
* Sphinx stylesheet -- nature theme.
* Sphinx stylesheet -- default theme.
*
* :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@import url("basic.css");
/* -- page layout ----------------------------------------------------------- */
body {
font-family: Arial, sans-serif;
font-family: sans-serif;
font-size: 100%;
background-color: #111;
color: #555;
background-color: #11303d;
color: #000;
margin: 0;
padding: 0;
}
div.document {
background-color: #1c4e63;
}
div.documentwrapper {
float: left;
width: 100%;
......@@ -31,211 +35,218 @@ div.bodywrapper {
margin: 0 0 0 230px;
}
hr {
border: 1px solid #B1B4B6;
}
div.document {
background-color: #eee;
}
div.body {
background-color: #ffffff;
color: #3E4349;
padding: 0 30px 30px 30px;
font-size: 0.9em;
color: #000000;
padding: 0 20px 30px 20px;
}
div.footer {
color: #555;
color: #ffffff;
width: 100%;
padding: 13px 0;
padding: 9px 0 9px 0;
text-align: center;
font-size: 75%;
}
div.footer a {
color: #444;
color: #ffffff;
text-decoration: underline;
}
div.related {
background-color: #6BA81E;
line-height: 32px;
color: #fff;
text-shadow: 0px 1px 0 #444;
font-size: 0.9em;
background-color: #133f52;
line-height: 30px;
color: #ffffff;
}
div.related a {
color: #E2F3CC;
color: #ffffff;
}
div.sphinxsidebar {
font-size: 0.75em;
line-height: 1.5em;
}
div.sphinxsidebarwrapper{
padding: 20px 0;
}
div.sphinxsidebar h3,
div.sphinxsidebar h4 {
font-family: Arial, sans-serif;
color: #222;
font-size: 1.2em;
div.sphinxsidebar h3 {
font-family: 'Trebuchet MS', sans-serif;
color: #ffffff;
font-size: 1.4em;
font-weight: normal;
margin: 0;
padding: 5px 10px;
background-color: #ddd;
text-shadow: 1px 1px 0 white
padding: 0;
}
div.sphinxsidebar h4{
font-size: 1.1em;
}
div.sphinxsidebar h3 a {
color: #444;
color: #ffffff;
}
div.sphinxsidebar h4 {
font-family: 'Trebuchet MS', sans-serif;
color: #ffffff;
font-size: 1.3em;
font-weight: normal;
margin: 5px 0 0 0;
padding: 0;
}
div.sphinxsidebar p {
color: #888;
padding: 5px 20px;
color: #ffffff;
}
div.sphinxsidebar p.topless {
margin: 5px 10px 10px 10px;
}
div.sphinxsidebar ul {
margin: 10px 20px;
margin: 10px;
padding: 0;
color: #000;
color: #ffffff;
}
div.sphinxsidebar a {
color: #444;
color: #98dbcc;
}
div.sphinxsidebar input {
border: 1px solid #ccc;
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
div.sphinxsidebar input[type=text]{
margin-left: 20px;
}
/* -- body styles ----------------------------------------------------------- */
/* -- hyperlink styles ------------------------------------------------------ */
a {
color: #005B81;
color: #355f7c;
text-decoration: none;
}
a:visited {
color: #355f7c;
text-decoration: none;
}
a:hover {
color: #E32E00;
text-decoration: underline;
}
/* -- body styles ----------------------------------------------------------- */
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
font-family: Arial, sans-serif;
background-color: #BED4EB;
font-family: 'Trebuchet MS', sans-serif;
background-color: #f2f2f2;
font-weight: normal;
color: #212224;
margin: 30px 0px 10px 0px;
padding: 5px 0 5px 10px;
text-shadow: 0px 1px 0 white
}
div.body h1 { border-top: 20px solid white; margin-top: 0; font-size: 200%; }
div.body h2 { font-size: 150%; background-color: #C8D5E3; }
div.body h3 { font-size: 120%; background-color: #D8DEE3; }
div.body h4 { font-size: 110%; background-color: #D8DEE3; }
div.body h5 { font-size: 100%; background-color: #D8DEE3; }
div.body h6 { font-size: 100%; background-color: #D8DEE3; }
color: #20435c;
border-bottom: 1px solid #ccc;
margin: 20px -20px 10px -20px;
padding: 3px 0 3px 10px;
}
div.body h1 { margin-top: 0; font-size: 200%; }
div.body h2 { font-size: 160%; }
div.body h3 { font-size: 140%; }
div.body h4 { font-size: 120%; }
div.body h5 { font-size: 110%; }
div.body h6 { font-size: 100%; }
a.headerlink {
color: #c60f0f;
font-size: 0.8em;
padding: 0 4px 0 4px;
text-decoration: none;
}
a.headerlink:hover {
background-color: #c60f0f;
color: white;
}
div.body p, div.body dd, div.body li {
line-height: 1.5em;
text-align: justify;
line-height: 130%;
}
div.admonition p.admonition-title + p {
display: inline;
}
div.highlight{
background-color: white;
div.admonition p {
margin-bottom: 5px;
}
div.admonition pre {
margin-bottom: 5px;
}
div.admonition ul, div.admonition ol {
margin-bottom: 5px;
}
div.note {
background-color: #eee;
border: 1px solid #ccc;
}
div.seealso {
background-color: #ffc;
border: 1px solid #ff6;
}
div.topic {
background-color: #eee;
}
div.warning {
background-color: #ffe4e4;
border: 1px solid #f66;
}
p.admonition-title {
display: inline;
}
p.admonition-title:after {
content: ":";
}
pre {
padding: 10px;
background-color: White;
color: #222;
line-height: 1.2em;
border: 1px solid #C6C9CB;
font-size: 1.1em;
margin: 1.5em 0 1.5em 0;
-webkit-box-shadow: 1px 1px 1px #d8d8d8;
-moz-box-shadow: 1px 1px 1px #d8d8d8;
}
padding: 5px;
background-color: #eeffcc;
color: #333333;
line-height: 120%;
border: 1px solid #ac9;
border-left: none;
border-right: none;
}
tt {
background-color: #ecf0f3;
color: #222;
/* padding: 1px 2px; */
font-size: 1.1em;
font-family: monospace;
padding: 0 1px 0 1px;
font-size: 0.95em;
}
th {
background-color: #ede;
}
.warning tt {
background: #efc2c2;
}
.note tt {
background: #d6d6d6;
}
.viewcode-back {
font-family: Arial, sans-serif;
font-family: sans-serif;
}
div.viewcode-block:target {
......
docs/_build/html/_static/sidebar.js 0 → 100644
/*
* sidebar.js
* ~~~~~~~~~~
*
* This script makes the Sphinx sidebar collapsible.
*
* .sphinxsidebar contains .sphinxsidebarwrapper. This script adds
* in .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton
* used to collapse and expand the sidebar.
*
* When the sidebar is collapsed the .sphinxsidebarwrapper is hidden
* and the width of the sidebar and the margin-left of the document
* are decreased. When the sidebar is expanded the opposite happens.
* This script saves a per-browser/per-session cookie used to
* remember the position of the sidebar among the pages.
* Once the browser is closed the cookie is deleted and the position
* reset to the default (expanded).
*
* :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
$(function() {
// global elements used by the functions.
// the 'sidebarbutton' element is defined as global after its
// creation, in the add_sidebar_button function
var bodywrapper = $('.bodywrapper');
var sidebar = $('.sphinxsidebar');
var sidebarwrapper = $('.sphinxsidebarwrapper');
// for some reason, the document has no sidebar; do not run into errors
if (!sidebar.length) return;
// original margin-left of the bodywrapper and width of the sidebar
// with the sidebar expanded
var bw_margin_expanded = bodywrapper.css('margin-left');
var ssb_width_expanded = sidebar.width();
// margin-left of the bodywrapper and width of the sidebar
// with the sidebar collapsed
var bw_margin_collapsed = '.8em';
var ssb_width_collapsed = '.8em';
// colors used by the current theme
var dark_color = $('.related').css('background-color');
var light_color = $('.document').css('background-color');
function sidebar_is_collapsed() {
return sidebarwrapper.is(':not(:visible)');
}
function toggle_sidebar() {
if (sidebar_is_collapsed())
expand_sidebar();
else
collapse_sidebar();
}
function collapse_sidebar() {
sidebarwrapper.hide();
sidebar.css('width', ssb_width_collapsed);
bodywrapper.css('margin-left', bw_margin_collapsed);
sidebarbutton.css({
'margin-left': '0',
'height': bodywrapper.height()
});
sidebarbutton.find('span').text('»');
sidebarbutton.attr('title', _('Expand sidebar'));
document.cookie = 'sidebar=collapsed';
}
function expand_sidebar() {
bodywrapper.css('margin-left', bw_margin_expanded);
sidebar.css('width', ssb_width_expanded);
sidebarwrapper.show();
sidebarbutton.css({
'margin-left': ssb_width_expanded-12,
'height': bodywrapper.height()
});
sidebarbutton.find('span').text('«');
sidebarbutton.attr('title', _('Collapse sidebar'));
document.cookie = 'sidebar=expanded';
}
function add_sidebar_button() {
sidebarwrapper.css({
'float': 'left',
'margin-right': '0',
'width': ssb_width_expanded - 28
});
// create the button
sidebar.append(
'<div id="sidebarbutton"><span>&laquo;</span></div>'
);
var sidebarbutton = $('#sidebarbutton');
light_color = sidebarbutton.css('background-color');
// find the height of the viewport to center the '<<' in the page
var viewport_height;
if (window.innerHeight)
viewport_height = window.innerHeight;
else
viewport_height = $(window).height();
sidebarbutton.find('span').css({
'display': 'block',
'margin-top': (viewport_height - sidebar.position().top - 20) / 2
});
sidebarbutton.click(toggle_sidebar);
sidebarbutton.attr('title', _('Collapse sidebar'));
sidebarbutton.css({
'color': '#FFFFFF',
'border-left': '1px solid ' + dark_color,
'font-size': '1.2em',
'cursor': 'pointer',
'height': bodywrapper.height(),
'padding-top': '1px',
'margin-left': ssb_width_expanded - 12
});
sidebarbutton.hover(
function () {
$(this).css('background-color', dark_color);
},
function () {
$(this).css('background-color', light_color);
}
);
}
function set_position_from_cookie() {
if (!document.cookie)
return;
var items = document.cookie.split(';');
for(var k=0; k<items.length; k++) {
var key_val = items[k].split('=');
var key = key_val[0].replace(/ /, ""); // strip leading spaces
if (key == 'sidebar') {
var value = key_val[1];
if ((value == 'collapsed') && (!sidebar_is_collapsed()))
collapse_sidebar();
else if ((value == 'expanded') && (sidebar_is_collapsed()))
expand_sidebar();
}
}
}
add_sidebar_button();
var sidebarbutton = $('#sidebarbutton');
set_position_from_cookie();
});
\ No newline at end of file
docs/_build/html/genindex.html
......@@ -7,15 +7,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index &mdash; pygeoip 0.3.0 documentation</title>
<title>Index &mdash; pygeoip 0.3.1 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.3.0',
VERSION: '0.3.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
......@@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pygeoip 0.3.0 documentation" href="index.html" />
<link rel="top" title="pygeoip 0.3.1 documentation" href="index.html" />
</head>
<body>
<div class="related">
......@@ -33,7 +33,7 @@
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">pygeoip 0.3.0 documentation</a> &raquo;</li>
<li><a href="index.html">pygeoip 0.3.1 documentation</a> &raquo;</li>
</ul>
</div>
......@@ -46,8 +46,36 @@
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="#_"><strong>_</strong></a>
| <a href="#C"><strong>C</strong></a>
</div>
<h2 id="_">_</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#pygeoip.GeoIP.__init__">__init__() (pygeoip.GeoIP method)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#pygeoip.GeoIP.country_code_by_addr">country_code_by_addr() (pygeoip.GeoIP method)</a>
</dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#pygeoip.GeoIP.country_code_by_name">country_code_by_name() (pygeoip.GeoIP method)</a>
</dt>
</dl></td>
</tr></table>
</div>
......@@ -81,11 +109,11 @@
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li><a href="index.html">pygeoip 0.3.0 documentation</a> &raquo;</li>
<li><a href="index.html">pygeoip 0.3.1 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2013, Jennifer Ennis, William Tisäter.
&copy; Copyright 2014, Jennifer Ennis, William Tisäter.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
......
docs/_build/html/index.html
......@@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to pygeoip’s documentation! &mdash; pygeoip 0.3.0 documentation</title>
<title>Pure Python API for Maxmind’s binary GeoIP databases &mdash; pygeoip 0.3.1 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.3.0',
VERSION: '0.3.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
......@@ -23,7 +23,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="pygeoip 0.3.0 documentation" href="#" />
<link rel="top" title="pygeoip 0.3.1 documentation" href="#" />
</head>
<body>
<div class="related">
......@@ -32,7 +32,7 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li><a href="#">pygeoip 0.3.0 documentation</a> &raquo;</li>
<li><a href="#">pygeoip 0.3.1 documentation</a> &raquo;</li>
</ul>
</div>
......@@ -41,21 +41,52 @@
<div class="bodywrapper">
<div class="body">
<div class="section" id="welcome-to-pygeoip-s-documentation">
<h1>Welcome to pygeoip&#8217;s documentation!<a class="headerlink" href="#welcome-to-pygeoip-s-documentation" title="Permalink to this headline"></a></h1>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul class="simple">
</ul>
<div class="section" id="pure-python-api-for-maxmind-s-binary-geoip-databases">
<h1>Pure Python API for Maxmind&#8217;s binary GeoIP databases<a class="headerlink" href="#pure-python-api-for-maxmind-s-binary-geoip-databases" title="Permalink to this headline"></a></h1>
<p>Work in progress!</p>
<div class="section" id="geoip-methods">
<h2><tt class="xref py py-class docutils literal"><span class="pre">GeoIP</span></tt> methods<a class="headerlink" href="#geoip-methods" title="Permalink to this headline"></a></h2>
<dl class="method">
<dt id="pygeoip.GeoIP.__init__">
<tt class="descclassname">GeoIP.</tt><tt class="descname">__init__</tt><big>(</big><em>filename</em>, <em>flags=0</em>, <em>cache=True</em><big>)</big><a class="headerlink" href="#pygeoip.GeoIP.__init__" title="Permalink to this definition"></a></dt>
<dd><p>Initialize the class.</p>
<p>&#64;param filename: Path to a geoip database.
&#64;type filename: str
&#64;param flags: Flags that affect how the database is processed.
Currently supported flags are STANDARD (the default),
MEMORY_CACHE (preload the whole file into memory) and
MMAP_CACHE (access the file via mmap).
&#64;type flags: int
&#64;param cache: Used in tests to skip instance caching
&#64;type cache: bool</p>
</dd></dl>
<div class="section" id="country-lookup">
<h3>Country lookup<a class="headerlink" href="#country-lookup" title="Permalink to this headline"></a></h3>
<dl class="method">
<dt id="pygeoip.GeoIP.country_code_by_addr">
<tt class="descclassname">GeoIP.</tt><tt class="descname">country_code_by_addr</tt><big>(</big><em>addr</em><big>)</big><a class="headerlink" href="#pygeoip.GeoIP.country_code_by_addr" title="Permalink to this definition"></a></dt>
<dd><p>Returns 2-letter country code (e.g. &#8216;US&#8217;) for specified IP address.
Use this method if you have a Country, Region, or City database.</p>
<p>&#64;param addr: IP address
&#64;type addr: str
&#64;return: 2-letter country code
&#64;rtype: str</p>
</dd></dl>
<dl class="method">
<dt id="pygeoip.GeoIP.country_code_by_name">
<tt class="descclassname">GeoIP.</tt><tt class="descname">country_code_by_name</tt><big>(</big><em>hostname</em><big>)</big><a class="headerlink" href="#pygeoip.GeoIP.country_code_by_name" title="Permalink to this definition"></a></dt>
<dd><p>Returns 2-letter country code (e.g. &#8216;US&#8217;) for specified hostname.
Use this method if you have a Country, Region, or City database.</p>
<p>&#64;param hostname: Hostname
&#64;type hostname: str
&#64;return: 2-letter country code
&#64;rtype: str</p>
</dd></dl>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
......@@ -66,8 +97,13 @@
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to pygeoip&#8217;s documentation!</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
<li><a class="reference internal" href="#">Pure Python API for Maxmind&#8217;s binary GeoIP databases</a><ul>
<li><a class="reference internal" href="#geoip-methods"><tt class="docutils literal"><span class="pre">GeoIP</span></tt> methods</a><ul>
<li><a class="reference internal" href="#country-lookup">Country lookup</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h3>This Page</h3>
......@@ -98,11 +134,11 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li><a href="#">pygeoip 0.3.0 documentation</a> &raquo;</li>
<li><a href="#">pygeoip 0.3.1 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2013, Jennifer Ennis, William Tisäter.
&copy; Copyright 2014, Jennifer Ennis, William Tisäter.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
......
docs/_build/html/search.html
......@@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Search &mdash; pygeoip 0.3.0 documentation</title>
<title>Search &mdash; pygeoip 0.3.1 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.3.0',
VERSION: '0.3.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
......@@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="top" title="pygeoip 0.3.0 documentation" href="index.html" />
<link rel="top" title="pygeoip 0.3.1 documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
......@@ -40,7 +40,7 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">pygeoip 0.3.0 documentation</a> &raquo;</li>
<li><a href="index.html">pygeoip 0.3.1 documentation</a> &raquo;</li>
</ul>
</div>
......@@ -88,11 +88,11 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li><a href="index.html">pygeoip 0.3.0 documentation</a> &raquo;</li>
<li><a href="index.html">pygeoip 0.3.1 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2013, Jennifer Ennis, William Tisäter.
&copy; Copyright 2014, Jennifer Ennis, William Tisäter.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</body>
......
docs/_build/html/searchindex.js
Search.setIndex({envversion:42,terms:{content:0,index:0,modul:0,search:0,page:0},objtypes:{},objnames:{},filenames:["index"],titles:["Welcome to pygeoip&#8217;s documentation!"],objects:{},titleterms:{pygeoip:0,document:0,welcom:0,indic:0,tabl:0}})
\ No newline at end of file
Search.setIndex({envversion:42,terms:{country_code_by_addr:0,via:0,have:0,process:0,skip:0,filenam:0,code:0,file:0,toctre:[],"__init__":0,current:0,thi:0,addr:0,memori:0,mmap_cach:0,mmap:0,support:0,param:0,"class":0,access:0,citi:0,bool:0,memory_cach:0,test:0,progress:0,you:0,type:0,preload:0,"return":0,hostnam:0,country_code_by_nam:0,initi:0,standard:0,how:0,flag:0,specifi:0,letter:0,address:0,affect:0,"true":0,cach:0,rtype:0,"default":0,region:0,work:0,"int":0,instanc:0,str:0,path:0,whole:0},objtypes:{"0":"py:method"},objnames:{"0":["py","method","Python method"]},filenames:["index"],titles:["Pure Python API for Maxmind&#8217;s binary GeoIP databases"],objects:{"pygeoip.GeoIP":{country_code_by_addr:[0,0,1,""],country_code_by_name:[0,0,1,""],"__init__":[0,0,1,""]}},titleterms:{pygeoip:[],python:0,geoip:0,binari:0,api:0,lookup:0,pure:0,databas:0,maxmind:0,countri:0,method:0}})
\ No newline at end of file
docs/conf.py
......@@ -14,11 +14,13 @@
import sys
import os
from datetime import date
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.join('..'))
import pygeoip
# -- General configuration ------------------------------------------------
......@@ -28,7 +30,7 @@ import os
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
extensions = ['sphinx.ext.autodoc']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
......@@ -44,16 +46,16 @@ master_doc = 'index'
# General information about the project.
project = u'pygeoip'
copyright = u'2013, Jennifer Ennis, William Tisäter'
copyright = u'%s, Jennifer Ennis, William Tisäter' % date.today().year
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.3.0'
version = pygeoip.__version__
# The full version, including alpha/beta/rc tags.
release = '0.3.0'
release = pygeoip.__version__
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
......@@ -98,7 +100,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'nature'
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
......
docs/index.txt
.. pygeoip documentation master file, created by
sphinx-quickstart on Thu Nov 14 10:52:22 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
====================================================
Pure Python API for Maxmind's binary GeoIP databases
====================================================
Welcome to pygeoip's documentation!
===================================
.. currentmodule:: pygeoip
Contents:
Work in progress!
.. toctree::
:maxdepth: 2
:class:`GeoIP` methods
----------------------
.. automethod:: GeoIP.__init__
Country lookup
''''''''''''''
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. automethod:: GeoIP.country_code_by_addr
.. automethod:: GeoIP.country_code_by_name
.. toctree
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment