Commits

Anonymous committed 1a555ac

Move module docs to module subdirectory.

  • Participants
  • Parent commits 70992cc

Comments (0)

Files changed (9)

docs/constants.rst

-:mod:`webhelpers.constants`
-================================================
-
-.. automodule:: webhelpers.constants
-
-.. currentmodule:: webhelpers.constants
-
-Countries
----------
-
-.. autofunction:: country_codes
-
-States & Provinces
-------------------
-
-.. autofunction:: us_states
-.. autofunction:: us_territories
-.. autofunction:: canada_provinces
-.. autofunction:: uk_counties
-
-Deprecations
-------------
-
-The timezone helpers were removed in WebHelpers 0.6.  Install the PyTZ
-package if you need them.

docs/containers.rst

-:mod:`webhelpers.containers`
-================================================
-
-.. automodule:: webhelpers.containers
-
-.. currentmodule:: webhelpers.containers
-
-.. autoclass:: NotGiven
-.. autoclass:: DumbObject
-.. autoclass:: Counter
-.. autoclass:: Accumulator
-.. autoclass:: UniqueAccumulator
-
-.. autofunction:: unique
-.. autofunction:: only_some_keys
-.. autofunction:: except_keys
-.. autofunction:: extract_keys
-.. autofunction:: ordered_items
-.. autofunction:: del_quiet
-.. autofunction:: correlate_dicts
-.. autofunction:: correlate_objects
-.. autofunction:: distribute
-.. autofunction:: transpose
-

docs/contents.rst

    :maxdepth: 1
    
    overview
-   constants
-   containers
-   date
-   feedgenerator
+   modules/constants
+   modules/containers
+   modules/date
+   modules/feedgenerator
 
 .. toctree::
    :maxdepth: 1
 
    changes
+   todo
    modules
-   todo
 
 
 Indices and tables

docs/date.rst

-:mod:`webhelpers.date`
-================================================
-
-.. automodule:: webhelpers.date
-
-.. currentmodule:: webhelpers.date
-
-.. autofunction:: distance_of_time_in_words
-.. autofunction:: time_ago_in_words

docs/feedgenerator.rst

-:mod:`webhelpers.feedgenerator`
-================================================
-
-.. automodule:: webhelpers.feedgenerator
-
-.. currentmodule:: webhelpers.feedgenerator
-
-Classes
--------
-
-.. autoclass:: SyndicationFeed
-    :members:
-    :undoc-members:
-
-.. autoclass:: Enclosure
-    :members:
-    :undoc-members:
-
-.. autoclass:: RssFeed
-    :members:
-    :undoc-members:
-
-.. autoclass:: RssUserland091Feed
-    :members:
-    :undoc-members:
-
-.. autoclass:: Rss201rev2Feed
-    :members:
-    :undoc-members:
-
-.. autoclass:: Atom1Feed
-    :members:
-    :undoc-members:
-
-``DefaultFeed`` is an alias for ``Rss201rev2Feed``.
-
-Functions
----------
-
-.. autofunction:: rfc2822_date
-.. autofunction:: rfc3339_date
-.. autofunction:: get_tag_uri

docs/modules/constants.rst

+:mod:`webhelpers.constants`
+================================================
+
+.. automodule:: webhelpers.constants
+
+.. currentmodule:: webhelpers.constants
+
+Countries
+---------
+
+.. autofunction:: country_codes
+
+States & Provinces
+------------------
+
+.. autofunction:: us_states
+.. autofunction:: us_territories
+.. autofunction:: canada_provinces
+.. autofunction:: uk_counties
+
+Deprecations
+------------
+
+The timezone helpers were removed in WebHelpers 0.6.  Install the PyTZ
+package if you need them.

docs/modules/containers.rst

+:mod:`webhelpers.containers`
+================================================
+
+.. automodule:: webhelpers.containers
+
+.. currentmodule:: webhelpers.containers
+
+.. autoclass:: NotGiven
+.. autoclass:: DumbObject
+.. autoclass:: Counter
+.. autoclass:: Accumulator
+.. autoclass:: UniqueAccumulator
+
+.. autofunction:: unique
+.. autofunction:: only_some_keys
+.. autofunction:: except_keys
+.. autofunction:: extract_keys
+.. autofunction:: ordered_items
+.. autofunction:: del_quiet
+.. autofunction:: correlate_dicts
+.. autofunction:: correlate_objects
+.. autofunction:: distribute
+.. autofunction:: transpose
+

docs/modules/date.rst

+:mod:`webhelpers.date`
+================================================
+
+.. automodule:: webhelpers.date
+
+.. currentmodule:: webhelpers.date
+
+.. autofunction:: distance_of_time_in_words
+.. autofunction:: time_ago_in_words

docs/modules/feedgenerator.rst

+:mod:`webhelpers.feedgenerator`
+================================================
+
+.. automodule:: webhelpers.feedgenerator
+
+.. currentmodule:: webhelpers.feedgenerator
+
+Classes
+-------
+
+.. autoclass:: SyndicationFeed
+    :members:
+    :undoc-members:
+
+.. autoclass:: Enclosure
+    :members:
+    :undoc-members:
+
+.. autoclass:: RssFeed
+    :members:
+    :undoc-members:
+
+.. autoclass:: RssUserland091Feed
+    :members:
+    :undoc-members:
+
+.. autoclass:: Rss201rev2Feed
+    :members:
+    :undoc-members:
+
+.. autoclass:: Atom1Feed
+    :members:
+    :undoc-members:
+
+``DefaultFeed`` is an alias for ``Rss201rev2Feed``.
+
+Functions
+---------
+
+.. autofunction:: rfc2822_date
+.. autofunction:: rfc3339_date
+.. autofunction:: get_tag_uri