Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jdidion committed Nov 7, 2016
1 parent 289c461 commit 8985143
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ xphyle is available from pypi::

xphyle tries to use the compression programs installed on your local machine (e.g. gzip, bzip2); if it can't, it will use the built-in python libraries (which are slower). Thus, xphyle has no required dependencies, but we recommend that if you install gzip, etc. if you don't already have them.

xphyle will use `pigz <http://zlib.net/pigz/>`_ for multi-threaded gzip compression if it is available. Multithreading is support disabled by default; to set the number of threads that xphyle should use::
xphyle will use `pigz <http://zlib.net/pigz/>`_ for multi-threaded gzip compression if it is available. Multithreading support is disabled by default; to set the number of threads that xphyle should use::

xphyle.configure(threads=4)

Expand Down Expand Up @@ -52,10 +52,10 @@ For system-level operations, an executable is required that reads from stdin and
xphyle.configure(system_progress=True)

You can also use your own preferred program by passing a tuple with the command and arguments (:ref:`<xphyle.progress.system_progress_command>` simplifies this)::
You can also use your own preferred program by passing a tuple with the command and arguments (:py:func:`<xphyle.progress.system_progress_command>` simplifies this)::
xphyle.configure(system_progress=xphyle.progress.system_progress_command(
'pv', '-pre', require=True)
'pv', '-pre', require=True))

Opening files
-------------
Expand All @@ -66,7 +66,7 @@ Other useful tools
Extending xphyle
----------------

You can add support for another compression format by extending one of the base classes in :ref:`<xphyle.format>`::
You can add support for another compression format by extending one of the base classes in :py:mod:`<xphyle.format>`::
class FooFormat(SingleExeCompressionFormat):
"""Implementation of CompressionFormat for bzip2 files.
Expand Down

0 comments on commit 8985143

Please sign in to comment.