Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
joepie91 committed Nov 24, 2013
1 parent fc828db commit d8c5942
Show file tree
Hide file tree
Showing 13 changed files with 1,283 additions and 0 deletions.
14 changes: 14 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004

Copyright (C) 2004 Sam Hocevar <[email protected]>

Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.

DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. You just DO WHAT THE FUCK YOU WANT TO.

161 changes: 161 additions & 0 deletions doc/contribute.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
<!doctype html>
<html>
<head>
<style>
body {
background-color: #F5F5F5;
font-family: sans-serif;
margin-right: 40px;
}

h2, h3, h4, h5, h6, h7
{
margin-top: 16px;
margin-bottom: 4px;
}

.children { padding-left: 40px; }

.definition
{
font-weight: bold;
margin-bottom: 32px;
}

.example
{
padding: 5px 6px;
font-weight: bold;
font-size: 15px;
background-color: #E6E6E6;
margin-top: 11px;
}

.example > .children
{
padding-top: 11px;
padding-left: 10px;
}

.example > .children > h7
{
font-size: 13px;
}

h7
{
font-size: 14px;
font-weight: bold;
margin-bottom: 2px;
}

pre
{
margin-top: 0px;
padding: 6px 7px;
background-color: #D9D9D9;
font-weight: normal;
font-size: 13px;
}

dl
{
margin: 5px 0px;
}

dt
{
font-weight: bold;
}

dd
{
font-size: 14px;
font-weight: normal;
margin-left: 8px;
}

dd > .children
{
font-size: 95%;
}

dd > .children > dl > dd
{
margin-left: 13px;
}

.exclamation
{
padding: 7px 8px;
margin: 11px 0px;
background-color: #FFE9AA;
border: 1px solid yellow;
font-size: 15px;
font-weight: normal;
}

.text
{
font-size: 15px;
font-weight: normal;
margin-bottom: 14px;
margin-top: 10px;
}

.toc
{
border: 1px solid gray;
background-color: #E6E6E6;
padding: 8px 9px;
font-size: 15px;
margin-bottom: 12px;
}

.toc h2
{
margin: 0px 0px 3px 0px;
font-size: 19px;
}

.toc ul
{
margin-top: 0px;
margin-bottom: 0px;
padding-left: 25px;
}

.toc li
{
margin-bottom: 2px;
}

.toc .alternatives
{
font-size: 12px;
}

.toc a
{
color: #292722;
}

.toc a:hover
{
color: black;
}

.fixed
{
font-family: monospace;
background-color: white;
padding: 1px 4px;
border: 1px solid silver;
border-radius: 4px;
}
</style>
</head>
<body>
<div class="children"><h1>Contributing</h1><div class="text"><a href="index.html"><< back to index</a></div><div class="text">Contributions are very welcome! For now, please refer to the README in the <a href="https://github.com/joepie91/python-whois">GitHub repository</a>.</div><div class="text">Please do note that there is a solid testing procedure in place to prevent accidental parser breakage; contributions will only be accepted if they pass all tests!</div></div>
</body>
</html>
7 changes: 7 additions & 0 deletions doc/contribute.zpy
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Contributing

{>index}(<< back to index)

Contributions are very welcome! For now, please refer to the README in the {https://github.com/joepie91/python-whois}(GitHub repository).

Please do note that there is a solid testing procedure in place to prevent accidental parser breakage; contributions will only be accepted if they pass all tests!
173 changes: 173 additions & 0 deletions doc/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
<!doctype html>
<html>
<head>
<style>
body {
background-color: #F5F5F5;
font-family: sans-serif;
margin-right: 40px;
}

h2, h3, h4, h5, h6, h7
{
margin-top: 16px;
margin-bottom: 4px;
}

.children { padding-left: 40px; }

.definition
{
font-weight: bold;
margin-bottom: 32px;
}

.example
{
padding: 5px 6px;
font-weight: bold;
font-size: 15px;
background-color: #E6E6E6;
margin-top: 11px;
}

.example > .children
{
padding-top: 11px;
padding-left: 10px;
}

.example > .children > h7
{
font-size: 13px;
}

h7
{
font-size: 14px;
font-weight: bold;
margin-bottom: 2px;
}

pre
{
margin-top: 0px;
padding: 6px 7px;
background-color: #D9D9D9;
font-weight: normal;
font-size: 13px;
}

dl
{
margin: 5px 0px;
}

dt
{
font-weight: bold;
}

dd
{
font-size: 14px;
font-weight: normal;
margin-left: 8px;
}

dd > .children
{
font-size: 95%;
}

dd > .children > dl > dd
{
margin-left: 13px;
}

.exclamation
{
padding: 7px 8px;
margin: 11px 0px;
background-color: #FFE9AA;
border: 1px solid yellow;
font-size: 15px;
font-weight: normal;
}

.text
{
font-size: 15px;
font-weight: normal;
margin-bottom: 14px;
margin-top: 10px;
}

.toc
{
border: 1px solid gray;
background-color: #E6E6E6;
padding: 8px 9px;
font-size: 15px;
margin-bottom: 12px;
}

.toc h2
{
margin: 0px 0px 3px 0px;
font-size: 19px;
}

.toc ul
{
margin-top: 0px;
margin-bottom: 0px;
padding-left: 25px;
}

.toc li
{
margin-bottom: 2px;
}

.toc .alternatives
{
font-size: 12px;
}

.toc a
{
color: #292722;
}

.toc a:hover
{
color: black;
}

.fixed
{
font-family: monospace;
background-color: white;
padding: 1px 4px;
border: 1px solid silver;
border-radius: 4px;
}
</style>
</head>
<body>
<div class="children"><h1>pythonwhois</h1><div class="text">A Python library for retrieving and parsing WHOIS data.</div><ul><li><a href="install.html">Installing pythonwhois</a></li><li> <a href="upgrade.html">Upgrading from a previous pythonwhois version</a></li><li> <a href="usage.html">Using pythonwhois in your application</a></li><li> <a href="troubleshoot.html">What to do when it doesn't work</a></li><li> <a href="contribute.html">Contributing to pythonwhois</a></li></ul><div class="text"><strong>pythonwhois is licensed under the <a href="http://wtfpl.net/">WTFPL</a>.</strong> This means that you can pretty much do anything with it.</div><h7>Code:</h7><pre class="code"> DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004

Copyright (C) 2004 Sam Hocevar &lt;[email protected]&gt;

Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.

DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. You just DO WHAT THE FUCK YOU WANT TO.</pre><div class="text">If you really don't like the WTFPL, <a href="https://creativecommons.org/publicdomain/zero/1.0/">CC0</a> is also fine.</div></div>
</body>
</html>
27 changes: 27 additions & 0 deletions doc/index.zpy
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# pythonwhois

A Python library for retrieving and parsing WHOIS data.

* {>install}(Installing pythonwhois)
* {>upgrade}(Upgrading from a previous pythonwhois version)
* {>usage}(Using pythonwhois in your application)
* {>troubleshoot}(What to do when it doesn't work)
* {>contribute}(Contributing to pythonwhois)

__pythonwhois is licensed under the {http://wtfpl.net/}(WTFPL).__ This means that you can pretty much do anything with it.

$ DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004

$$ Copyright (C) 2004 Sam Hocevar <[email protected]>

$$ Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.

$$ DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

$$ 0. You just DO WHAT THE FUCK YOU WANT TO.

If you really don't like the WTFPL, {https://creativecommons.org/publicdomain/zero/1.0/}(CC0) is also fine.
Loading

0 comments on commit d8c5942

Please sign in to comment.