Mike Orr avatar Mike Orr committed f182da2

Put docs for non-essential modules in other.rst.

Comments (0)

Files changed (2)


-Minor subpackages
-.. toctree::
-  :maxdepth: 1
-  modules/markdown
-  modules/textile
+`Non-essential modules <modules/other.html>`_: markdown, textile, string24.


+Non-essential modules
+``webhelpers.markdown`` is a copy of Markdown 1.7, used as a fallback for
+``webhelpers.html.converters.markdown()`` if the full Markdown package is not
+installed. See the `Markdown <>` website for documentation on the Markdown
+format and this module.  Markdown is now at version 2.x and contains new
+features and plugins which are too big to include in WebHelpers. There is also
+an alternate implementation called Markdown2.  Both are available on PyPI.  See
+the ``markdown()`` documentation for how to use them with WebHelpers.
+``webhelpers.textile`` is a copy of Textile, used by
+``webhelpers.html.converters.textilize()``.  See the `Textile <>`_ site for
+documentation on the Textile format and this module.
+``webhelpers.string24`` is a copy of Python 2.4's ``string`` module, for
+programs still running on Python 2.3.  It will be removed in a future version
+of WebHelpers.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.