Skip to content

Commit

Permalink
Merge pull request #82 from Ayrx/fix-encoding-docs
Browse files Browse the repository at this point in the history
Removed use of autodocs for nacl.encoding module.
  • Loading branch information
alex committed Jul 13, 2014
2 parents cb255bb + e7ff0ec commit a7e64e1
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions docs/encoding.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Encoders
========

.. currentmodule:: nacl.encoding

PyNaCl supports a simple method of encoding and decoding messages in different
formats. Encoders are simple classes with staticmethods that encode/decode and
are typically passed as a keyword argument `encoder` to various methods.
Expand All @@ -21,23 +23,17 @@ Then you can later decode it from hex:
Built in Encoders
-----------------

.. autoclass:: nacl.encoding.RawEncoder
:members:
.. class:: RawEncoder

.. autoclass:: nacl.encoding.HexEncoder
:members:
.. class:: HexEncoder

.. autoclass:: nacl.encoding.Base16Encoder
:members:
.. class:: Base16Encoder

.. autoclass:: nacl.encoding.Base32Encoder
:members:
.. class:: Base32Encoder

.. autoclass:: nacl.encoding.Base64Encoder
:members:
.. class:: Base64Encoder

.. autoclass:: nacl.encoding.URLSafeBase64Encoder
:members:
.. class:: URLSafeBase64Encoder


Defining your own Encoder
Expand Down

0 comments on commit a7e64e1

Please sign in to comment.