Browse Source

emoji in docs

boyska 3 years ago
parent
commit
bacc3eb851
3 changed files with 14 additions and 2 deletions
  1. 6 1
      README.md
  2. 6 1
      docs/conf.py
  3. 2 0
      requirements_dev.txt

+ 6 - 1
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
 -------

+ 6 - 1
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']

+ 2 - 0
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