pydenticon Files · docs/index.rst

Files @ 5df4ce2fcaa9

Branch filter:

Location: pydenticon/docs/index.rst

5df4ce2fcaa9 843 B text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

branko

PYD-2: Added the introductory (about) chapter. Added description of the algorithm, together with example and information about limitations. Added automatically-generated API reference. Configured Sphinx to use parent directory for finding library modules. Added basic information to the index page, including website links. Added installation instructions. Added usage instructions with a couple of examples.

Pydenticon documentation
========================

Pydenticon is a small utility library that can be used for deterministically
generating identicons based on the hash of provided data.

The implementation is a port of the Sigil identicon implementation from:

* https://github.com/cupcake/sigil/

Support
-------

In case of problems with the library, please do not hestitate to contact the
author at **pydenticon (at) majic.rs**. The library itself is hosted on Github,
and on author's own websitea:

* https://github.com/azaghal/pydenticon
* https://code.majic.rs/pydenticon
* https://projects.majic.rs/pydenticon

Contents:

.. toctree::
   :maxdepth: 2

   about
   installation
   usage
   algorithm
   security
   apireference
   releasenotes

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`