Skip to content
This repository was archived by the owner on Apr 9, 2025. It is now read-only.

Docs: "Who is using it" section #229

Merged
merged 1 commit into from
Sep 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
'versionwarning.extension',
'notfound.extension',
'sphinxcontrib.bibtex',
'sphinxemoji.sphinxemoji',
]

bibtex_bibfiles = ['refs.bib']
Expand Down
Binary file added docs/crest-usage.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/disnake-usage.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/hypothesis-usage.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ Badges:
installation
usage
configuration
who-is-using-it
development
releasing

Expand Down
7 changes: 5 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Binary file added docs/returns-usage.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/scrapy-usage.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/setuptools-usage.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/tweepy-usage.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
89 changes: 89 additions & 0 deletions docs/who-is-using-it.rst
Original file line number Diff line number Diff line change
@@ -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%
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ doc = [
"sphinx-notfound-page",
"sphinx-autobuild",
"sphinxcontrib-bibtex",
"sphinxemoji",
]

[project.urls]
Expand Down