1. Artur Barseghyan
  2. tld

Commits

Artur Barseghyan  committed 7d8b140

better docs

  • Participants
  • Parent commits 0c04816
  • Branches default

Comments (0)

Files changed (4)

File .hgignore

View file
  • Ignore whitespace
 src/tld.egg*
 build/
 dist/
-builddocs/
+builddocs/
+builddocs.zip

File docs/index.rst

View file
  • Ignore whitespace
-.. tld documentation master file, created by
-   sphinx-quickstart on Sun May 12 18:34:31 2013.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+tld Package
+===========
+Extracts the top level domain (TLD) from the URL given. List of TLD names is taken from
+Mozilla http://mxr.mozilla.org/mozilla/source/netwerk/dns/src/effective_tld_names.dat?raw=1
 
-Welcome to tld's documentation!
-===============================
+Optionally raises exceptions on non-existing TLDs or silently fails (if `fail_silently` argument is set to True).
+Knows about active and inactive TLDs. If only active TLDs shall be matched against, `active_only` argument shall be
+set to True (default - False).
 
-Contents:
+:mod:`utils` Module
+-------------------
 
-.. toctree::
-   :maxdepth: 20
-
-   tld
-
+.. automodule:: tld.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
 Indices and tables
 ==================

File docs/tld.rst

  • Ignore whitespace
-tld Package
-===========
-
-:mod:`tld` Package
-------------------
-
-.. automodule:: tld.__init__
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`conf` Module
-------------------
-
-.. automodule:: tld.conf
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`defaults` Module
-----------------------
-
-.. automodule:: tld.defaults
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`exceptions` Module
-------------------------
-
-.. automodule:: tld.exceptions
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`tests` Module
--------------------
-
-.. automodule:: tld.tests
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`update` Module
---------------------
-
-.. automodule:: tld.update
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-:mod:`utils` Module
--------------------
-
-.. automodule:: tld.utils
-    :members:
-    :undoc-members:
-    :show-inheritance:
-

File src/tld/defaults.py

View file
  • Ignore whitespace
 # @author Artur Barseghyan (artur.barseghyan@gmail.com)
 # @version 0.1
 # @license MPL 1.1/GPL 2.0/LGPL 2.1
-# @link http://bitbucket.org/barseghyanartur/php-tld
+# @link http://bitbucket.org/barseghyanartur/tld
 #
 # Tld defaults
 
+# Source path of Mozilla's effective TLD names file.
 NAMES_SOURCE_URL = 'http://mxr.mozilla.org/mozilla/source/netwerk/dns/src/effective_tld_names.dat?raw=1'
+
+# Relative path to store the local copy of Mozilla's effective TLD names file.
 NAMES_LOCAL_PATH = 'res/effective_tld_names.dat.txt'
+
+# Debug flag.
 DEBUG = False