Mercurial > public > m209
changeset 69:2173ac4c2d9b
Adjust TOC depth. Add link to StdProcedure from M209 description.
| author | Brian Neal <bgneal@gmail.com> |
|---|---|
| date | Sun, 21 Jul 2013 14:07:20 -0500 |
| parents | 30aa114bb746 |
| children | 753974fc7619 |
| files | docs/index.rst docs/keylist.rst docs/m209.rst |
| diffstat | 3 files changed, 8 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/index.rst Sun Jul 21 14:03:55 2013 -0500 +++ b/docs/index.rst Sun Jul 21 14:07:20 2013 -0500 @@ -42,7 +42,7 @@ Contents: .. toctree:: - :maxdepth: 3 + :maxdepth: 2 tutorial commandline
--- a/docs/keylist.rst Sun Jul 21 14:03:55 2013 -0500 +++ b/docs/keylist.rst Sun Jul 21 14:07:20 2013 -0500 @@ -113,7 +113,7 @@ ``key_lists`` must be an iterable of :class:`~m209.keylist.KeyList` objects. Key list file format -++++++++++++++++++++ +~~~~~~~~~~~~~~~~~~~~ An example key list file in config file format is presented below. The label for each section of the file is the key list indicator.
--- a/docs/m209.rst Sun Jul 21 14:03:55 2013 -0500 +++ b/docs/m209.rst Sun Jul 21 14:07:20 2013 -0500 @@ -4,11 +4,12 @@ Naturally, the ``m209`` library includes a class that simulates a M-209 converter. The :class:`~m209.converter.M209` class allows you to experiment with all moving parts of an M-209, including encrypting and decrypting -messages. Keep in mind there is a higher level class, StdProcedure, that -encapsulates all the steps of the standard encrypting and decrypting -operations, including generating indicators and placing or removing them from -messages. However if you need lower-level access or you are inventing your own -procedures, you would use the M209 class directly. +messages. Keep in mind there is a higher level class, +:class:`~m209.procedure.StdProcedure`, that encapsulates all the steps of the +standard encrypting and decrypting operations, including generating indicators +and placing or removing them from messages. However if you need lower-level +access or you are inventing your own procedures, you would use the M209 class +directly. .. class:: m209.converter.M209([lugs=None[, pin_list=None]])