diff --git a/README.md b/README.md index 56358e9..0ce06e1 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,12 @@ banana Features -------- -- TODO + - Supports multiple, super-interesting bases: banana |:banana:|, ananas |:pineapple:|, ribes |:grapes:|, avocado |:avocado:| + - Encode and decode easily + - Check validity of encoded words + - Generate random words |:game_die:| + - It's easy to support additional bases based on the same principles |:jigsaw:| + Credits ------- diff --git a/docs/conf.py b/docs/conf.py index 7acdc7c..17af5df 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,7 +31,12 @@ import banana # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'm2r'] +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.viewcode", + "m2r", + "sphinxemoji.sphinxemoji", +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/requirements_dev.txt b/requirements_dev.txt index 298b3ca..23e9589 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -8,6 +8,8 @@ coverage==4.5.4 Sphinx==1.8.5 m2r==0.2.1 twine==1.14.0 +sphinxemoji==0.1.7 + pytest==4.6.5 pytest-runner==5.1