diff --git a/docs/conf.py b/docs/conf.py index 1dafcc28..98add11a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,6 +51,7 @@ 'versionwarning.extension', 'notfound.extension', 'sphinxcontrib.bibtex', + 'sphinxemoji.sphinxemoji', ] bibtex_bibfiles = ['refs.bib'] diff --git a/docs/crest-usage.gif b/docs/crest-usage.gif new file mode 100644 index 00000000..b0af5b07 Binary files /dev/null and b/docs/crest-usage.gif differ diff --git a/docs/disnake-usage.gif b/docs/disnake-usage.gif new file mode 100644 index 00000000..d17bbf85 Binary files /dev/null and b/docs/disnake-usage.gif differ diff --git a/docs/hypothesis-usage.gif b/docs/hypothesis-usage.gif new file mode 100644 index 00000000..ae32e47a Binary files /dev/null and b/docs/hypothesis-usage.gif differ diff --git a/docs/index.rst b/docs/index.rst index 6532eb80..102b4b58 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -90,6 +90,7 @@ Badges: installation usage configuration + who-is-using-it development releasing diff --git a/docs/requirements.txt b/docs/requirements.txt index be94e3a8..5f1041b6 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -10,7 +10,7 @@ astroid==2.12.9 # via sphinx-autoapi babel==2.10.3 # via sphinx -certifi==2022.6.15.1 +certifi==2022.6.15.2 # via requests charset-normalizer==2.1.1 # via requests @@ -23,7 +23,7 @@ docutils==0.17.1 # sphinx-rtd-theme # sphinx-tabs # sphinxcontrib-bibtex -idna==3.3 +idna==3.4 # via requests imagesize==1.4.1 # via sphinx @@ -80,6 +80,7 @@ sphinx==4.5.0 # sphinx-tabs # sphinx-version-warning # sphinxcontrib-bibtex + # sphinxemoji sphinx-autoapi==1.9.0 # via sphinx-hoverxref (pyproject.toml) sphinx-autobuild==2021.3.14 @@ -108,6 +109,8 @@ sphinxcontrib-qthelp==1.0.3 # via sphinx sphinxcontrib-serializinghtml==1.1.5 # via sphinx +sphinxemoji==0.2.0 + # via sphinx-hoverxref (pyproject.toml) tornado==6.2 # via livereload unidecode==1.3.4 diff --git a/docs/returns-usage.gif b/docs/returns-usage.gif new file mode 100644 index 00000000..07888999 Binary files /dev/null and b/docs/returns-usage.gif differ diff --git a/docs/scrapy-usage.gif b/docs/scrapy-usage.gif new file mode 100644 index 00000000..6f60d97d Binary files /dev/null and b/docs/scrapy-usage.gif differ diff --git a/docs/setuptools-usage.gif b/docs/setuptools-usage.gif new file mode 100644 index 00000000..5f0a88c7 Binary files /dev/null and b/docs/setuptools-usage.gif differ diff --git a/docs/tweepy-usage.gif b/docs/tweepy-usage.gif new file mode 100644 index 00000000..31826687 Binary files /dev/null and b/docs/tweepy-usage.gif differ diff --git a/docs/who-is-using-it.rst b/docs/who-is-using-it.rst new file mode 100644 index 00000000..94dcbb1b --- /dev/null +++ b/docs/who-is-using-it.rst @@ -0,0 +1,89 @@ +Who Is Using It? +================ + +These are some projects using this extension +that you can take a look at to understand how they are configured and what's the behavior. + +Setuptools +---------- + +|:books:| Repository + https://github.com/pypa/setuptools/ + +|:art:| Demo + .. image:: setuptools-usage.gif + :align: center + :width: 100% + + +disnake +------- + +|:books:| Repository + https://github.com/DisnakeDev/disnake/ + +|:art:| Demo + .. image:: disnake-usage.gif + :align: center + :width: 100% + + +returns +------- + +|:books:| Repository + https://github.com/dry-python/returns + +|:art:| Demo + .. image:: returns-usage.gif + :align: center + :width: 100% + + +scrapy +------ + +|:books:| Repository + https://github.com/scrapy/scrapy/ + +|:art:| Demo + .. image:: scrapy-usage.gif + :align: center + :width: 100% + + +tweepy +------ + +|:books:| Repository + https://github.com/tweepy/tweepy/ + +|:art:| Demo + .. image:: tweepy-usage.gif + :align: center + :width: 100% + + + +hypothesis +---------- + +|:books:| Repository + https://github.com/HypothesisWorks/hypothesis + +|:art:| Demo + .. image:: hypothesis-usage.gif + :align: center + :width: 100% + + +crest +----- + +|:books:| Repository + https://github.com/wave-harmonic/crest + +|:art:| Demo + .. image:: crest-usage.gif + :align: center + :width: 100% diff --git a/pyproject.toml b/pyproject.toml index d5cc612c..1091bb14 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -49,6 +49,7 @@ doc = [ "sphinx-notfound-page", "sphinx-autobuild", "sphinxcontrib-bibtex", + "sphinxemoji", ] [project.urls]