Permalink
Browse files

A few documentation fixes

  • Loading branch information...
1 parent 817f3d2 commit edf4d649a16fad8356739b34d49f4e440bffe58e @rkruppe rkruppe committed Sep 28, 2012
Showing with 7 additions and 6 deletions.
  1. +1 −1 docs/source/files.rst
  2. +4 −3 docs/source/pavement.rst
  3. +2 −2 paver/doctools.py
@@ -3,6 +3,6 @@
File Handling in Paver (paver.path)
===================================
-.. automodule:: paver.path25
+.. automodule:: paver.path
:members:
@@ -227,9 +227,9 @@ More complex dependencies
or environment, you might decide to call an appropriate task in the middle of
another one.
-There are two key options for fixing that::
+There are two key options for fixing that:
-# ``@might_call`` decorator, which indicates that task might invoke ``call_task`` on one or more of the specified tasks. This allows you to provide command line options to task that might be called (it is inserted in dependency chain)::
+#. ``@might_call`` decorator, which indicates that task might invoke ``call_task`` on one or more of the specified tasks. This allows you to provide command line options to task that might be called (it is inserted in dependency chain)::
@task
@cmdopts([
@@ -251,7 +251,8 @@ There are two key options for fixing that::
do_cleanup()
-# Providing options and arguments to another tasks directly. Options are provided with final assignet value::
+#. Providing options and arguments to another tasks directly.
+ Options are provided with final assigned value::
@task
@cmdopts([
View
@@ -332,15 +332,15 @@ def cog(options):
directory to look in for files to cog. If not set,
'docroot' is looked up.
pattern
- file glob to look for under basedir. By default,
- *.rst
+ file glob to look for under basedir. By default, ``*.rst``
includedir
If you have external files to include in your
documentation, setting includedir to the root
of those files will put a paver.doctools.Includer
in your Cog namespace as 'include'. This lets you
easily include files and sections of files. Here's
an example usage::
+
[[[cog include('filename_under_includedir.py', 'mysection')]]]
[[[end]]]
defines

0 comments on commit edf4d64

Please sign in to comment.