Benjamin Althues avatar Benjamin Althues committed b871a90

Update developer documentation and include README

Comments (0)

Files changed (3)

         '''Generate passphrase and store result in `passphrases`
 
         :Parameters:
-            - `password`: Password to use for passprase generation
+            - `password`: Password to use for passprase generation,
+                          a tuple `labeltup` with 4 values:
+                - `label`: Label to use for passprase generation
+                - `length`: Length to use for passprase generation
+                - `algo`: Algorithm to use for passprase generation
+                - `seqno`: Sequence number to use for passprase generation
 
-            A tuple `labeltup` with 4 values:
-            - `label`: Label to use for passprase generation
-            - `length`: Length to use for passprase generation
-            - `algo`: Algorithm to use for passprase generation
-            - `seqno`: Sequence number to use for passprase generation
         '''
 
         hasher = algoObject(algo)

dispass/filehandler.py

             - `label`: The labelname
 
         :Returns:
-            A tuple `labeltup` with 4 values ``(label, length, algo, seqno))``:
-
-            - `label`: Label to use for passprase generation
-            - `length`: Length to use for passprase generation
-            - `algo`: Algorithm to use for passprase generation
-            - `seqno`: Sequence number to use for passprase generation
+            - A tuple with 4 values ``(label, length, algo, seqno))``:
+                - `label`: Label to use for passprase generation
+                - `length`: Length to use for passprase generation
+                - `algo`: Algorithm to use for passprase generation
+                - `seqno`: Sequence number to use for passprase generation
 
         '''
 

sphinx-doc/en/index.rst

-Developer documentation
+User documentation
+******************************************************************************
+
+.. include:: ../../README.rst
+
+Development documentation
 ******************************************************************************
 
 * :ref:`genindex`
 .. automodule:: dispass.algos
    :members:
 
+dispass.common
+==============================================================================
+
+.. automodule:: dispass.common
+   :members:
+
 dispass.dispass
 ==============================================================================
 
 .. automodule:: dispass.interactive_editor
    :members:
 
+dispass.commands.add
+==============================================================================
+
+.. automodule:: dispass.commands.add
+   :members:
+
+dispass.commands.generate
+==============================================================================
+
+.. automodule:: dispass.commands.generate
+   :members:
+
+dispass.commands.gui
+==============================================================================
+
+.. automodule:: dispass.commands.gui
+   :members:
+
+dispass.commands.help
+==============================================================================
+
+.. automodule:: dispass.commands.help
+   :members:
+
+dispass.commands.list
+==============================================================================
+
+.. automodule:: dispass.commands.list
+   :members:
+
+dispass.commands.rm
+==============================================================================
+
+.. automodule:: dispass.commands.rm
+   :members:
+
+dispass.commands.version
+==============================================================================
+
+.. automodule:: dispass.commands.version
+   :members:
+
 
 .. vim: set et ts=3 sw=3 sts=3 ai:
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.