Skip to content

Commit

Permalink
docs: update for read the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fenekku authored and lnielsen committed Nov 5, 2019
1 parent 3ba3d01 commit bb745a3
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
9 changes: 5 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ base32-lib
:target: https://github.com/inveniosoftware/base32-lib/blob/master/LICENSE


Small library to generate, encode and decode random base32 strings with nice properties.
Small library to generate, encode and decode random base32 strings with nice
properties.

Usage
=====
Expand Down Expand Up @@ -58,12 +59,12 @@ Usage
Features
========

- Generation, encoding and decoding of strings
- Generation, encoding and decoding of base32 strings
- Douglas Crockford base32 encoding
- URL-safe strings with no problematic special characters
- Decoding of any-case strings
- Configurable length strings
- Randomness through cryptographically secure random number generator
- Douglas Crockford base32 encoding
- URL-safe strings with no problematic special characters
- Optional ISO-7064 checksum
- Optional hyphenation

Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@
html_theme = 'alabaster'

html_theme_options = {
'description': 'Small library for validating and normalising persistent '
'identifiers used in scholarly communication.',
'description': 'Small library to generate, encode and decode random '
'base32 strings with nice properties.',
'github_user': 'inveniosoftware',
'github_repo': 'base32-lib',
'github_button': False,
Expand Down

0 comments on commit bb745a3

Please sign in to comment.