Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marcwebbie committed Feb 9, 2016
1 parent cdbf56c commit 227f503
Show file tree
Hide file tree
Showing 13 changed files with 194 additions and 96 deletions.
13 changes: 6 additions & 7 deletions README.rst
Expand Up @@ -31,7 +31,7 @@ Outputs::

..
Check remote `passpie database <https://github.com/passpiedb>`_.
Check example remote passpie database: https://github.com/passpiedb.

Install
========
Expand All @@ -47,14 +47,13 @@ Or if you are on a mac, install via `Homebrew <http://brew.sh>`_:
brew install passpie
Documentation
Learn more
================

Read full documentation on http://passpie.readthedocs.org

Check an example remote database: https://github.com/marcwebbie/passpiedb

And visit our |Gitter|
Documentation: http://passpie.readthedocs.org
Mailing list: https://groups.google.com/d/forum/passpie
Gitter chat: https://gitter.im/marcwebbie/passpie
FAQ: http://passpie.readthedocs.org/en/latest/faq.html


Licence |License|
Expand Down
Binary file modified docs/_build/doctrees/changelog.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/configuration.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/contributing.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/faq.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/license.doctree
Binary file not shown.
29 changes: 29 additions & 0 deletions docs/_build/html/_sources/configuration.txt
Expand Up @@ -25,6 +25,10 @@ Full passpie configuration file
- login
- password
- comment
aliases:
st: status
rm: remove
ls: list
colors:
login: green
name: yellow
Expand Down Expand Up @@ -199,6 +203,31 @@ Supported color names:
- white (might be light gray)
- reset (reset the color code only)



``aliases``
-----------------------------------

| **Default:** ``{}``
| **Description:** Aliases to commands.


Example configuration:

.. code-block:: yaml

aliases:
st: status
rm: remove
a: add
u: update
l: log

We can then run our configuration with the short commands::

passpie rm foo@bar


``key_length``
-----------------------------------

Expand Down
191 changes: 103 additions & 88 deletions docs/_build/html/changelog.html

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions docs/_build/html/configuration.html
Expand Up @@ -58,6 +58,10 @@ <h3>Full passpie configuration file<a class="headerlink" href="#full-passpie-con
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">login</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">password</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">comment</span>
<span class="l l-Scalar l-Scalar-Plain">aliases</span><span class="p p-Indicator">:</span>
<span class="l l-Scalar l-Scalar-Plain">st</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">status</span>
<span class="l l-Scalar l-Scalar-Plain">rm</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">remove</span>
<span class="l l-Scalar l-Scalar-Plain">ls</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">list</span>
<span class="l l-Scalar l-Scalar-Plain">colors</span><span class="p p-Indicator">:</span>
<span class="l l-Scalar l-Scalar-Plain">login</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">green</span>
<span class="l l-Scalar l-Scalar-Plain">name</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">yellow</span>
Expand Down Expand Up @@ -244,6 +248,26 @@ <h2><code class="docutils literal"><span class="pre">colors</span></code><a clas
<li>reset (reset the color code only)</li>
</ul>
</div>
<div class="section" id="aliases">
<h2><code class="docutils literal"><span class="pre">aliases</span></code><a class="headerlink" href="#aliases" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><strong>Default:</strong> <code class="docutils literal"><span class="pre">{}</span></code></div>
<div class="line"><strong>Description:</strong> Aliases to commands.</div>
</div>
<p>Example configuration:</p>
<div class="highlight-yaml"><div class="highlight"><pre><span class="l l-Scalar l-Scalar-Plain">aliases</span><span class="p p-Indicator">:</span>
<span class="l l-Scalar l-Scalar-Plain">st</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">status</span>
<span class="l l-Scalar l-Scalar-Plain">rm</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">remove</span>
<span class="l l-Scalar l-Scalar-Plain">a</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">add</span>
<span class="l l-Scalar l-Scalar-Plain">u</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">update</span>
<span class="l l-Scalar l-Scalar-Plain">l</span><span class="p p-Indicator">:</span> <span class="l l-Scalar l-Scalar-Plain">log</span>
</pre></div>
</div>
<p>We can then run our configuration with the short commands:</p>
<div class="highlight-python"><div class="highlight"><pre>passpie rm foo@bar
</pre></div>
</div>
</div>
<div class="section" id="key-length">
<h2><code class="docutils literal"><span class="pre">key_length</span></code><a class="headerlink" href="#key-length" title="Permalink to this headline"></a></h2>
<div class="line-block">
Expand Down
2 changes: 2 additions & 0 deletions docs/_build/html/index.html
Expand Up @@ -127,6 +127,7 @@ <h2>Documentation Contents<a class="headerlink" href="#documentation-contents" t
<li class="toctree-l2"><a class="reference internal" href="configuration.html#hidden"><code class="docutils literal"><span class="pre">hidden</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#hidden-string"><code class="docutils literal"><span class="pre">hidden_string</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#colors"><code class="docutils literal"><span class="pre">colors</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#aliases"><code class="docutils literal"><span class="pre">aliases</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#key-length"><code class="docutils literal"><span class="pre">key_length</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#repo"><code class="docutils literal"><span class="pre">repo</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="configuration.html#status-repeated-passwords-limit"><code class="docutils literal"><span class="pre">status_repeated_passwords_limit</span></code></a></li>
Expand Down Expand Up @@ -160,6 +161,7 @@ <h2>Miscellaneous Pages<a class="headerlink" href="#miscellaneous-pages" title="
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-4-0">Version 1.4.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-3-1">Version 1.3.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-3-0">Version 1.3.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-2-0">Version 1.2.0</a></li>
Expand Down

0 comments on commit 227f503

Please sign in to comment.