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

Commit bb08906

Browse files
authored
Docs: "Who is using it" section (#229)
1 parent df90a9e commit bb08906

12 files changed

+97
-2
lines changed

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151
'versionwarning.extension',
5252
'notfound.extension',
5353
'sphinxcontrib.bibtex',
54+
'sphinxemoji.sphinxemoji',
5455
]
5556

5657
bibtex_bibfiles = ['refs.bib']

docs/crest-usage.gif

303 KB
Loading

docs/disnake-usage.gif

177 KB
Loading

docs/hypothesis-usage.gif

237 KB
Loading

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ Badges:
9090
installation
9191
usage
9292
configuration
93+
who-is-using-it
9394
development
9495
releasing
9596

docs/requirements.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ astroid==2.12.9
1010
# via sphinx-autoapi
1111
babel==2.10.3
1212
# via sphinx
13-
certifi==2022.6.15.1
13+
certifi==2022.6.15.2
1414
# via requests
1515
charset-normalizer==2.1.1
1616
# via requests
@@ -23,7 +23,7 @@ docutils==0.17.1
2323
# sphinx-rtd-theme
2424
# sphinx-tabs
2525
# sphinxcontrib-bibtex
26-
idna==3.3
26+
idna==3.4
2727
# via requests
2828
imagesize==1.4.1
2929
# via sphinx
@@ -80,6 +80,7 @@ sphinx==4.5.0
8080
# sphinx-tabs
8181
# sphinx-version-warning
8282
# sphinxcontrib-bibtex
83+
# sphinxemoji
8384
sphinx-autoapi==1.9.0
8485
# via sphinx-hoverxref (pyproject.toml)
8586
sphinx-autobuild==2021.3.14
@@ -108,6 +109,8 @@ sphinxcontrib-qthelp==1.0.3
108109
# via sphinx
109110
sphinxcontrib-serializinghtml==1.1.5
110111
# via sphinx
112+
sphinxemoji==0.2.0
113+
# via sphinx-hoverxref (pyproject.toml)
111114
tornado==6.2
112115
# via livereload
113116
unidecode==1.3.4

docs/returns-usage.gif

213 KB
Loading

docs/scrapy-usage.gif

190 KB
Loading

docs/setuptools-usage.gif

212 KB
Loading

docs/tweepy-usage.gif

123 KB
Loading

docs/who-is-using-it.rst

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
Who Is Using It?
2+
================
3+
4+
These are some projects using this extension
5+
that you can take a look at to understand how they are configured and what's the behavior.
6+
7+
Setuptools
8+
----------
9+
10+
|:books:| Repository
11+
https://github.com/pypa/setuptools/
12+
13+
|:art:| Demo
14+
.. image:: setuptools-usage.gif
15+
:align: center
16+
:width: 100%
17+
18+
19+
disnake
20+
-------
21+
22+
|:books:| Repository
23+
https://github.com/DisnakeDev/disnake/
24+
25+
|:art:| Demo
26+
.. image:: disnake-usage.gif
27+
:align: center
28+
:width: 100%
29+
30+
31+
returns
32+
-------
33+
34+
|:books:| Repository
35+
https://github.com/dry-python/returns
36+
37+
|:art:| Demo
38+
.. image:: returns-usage.gif
39+
:align: center
40+
:width: 100%
41+
42+
43+
scrapy
44+
------
45+
46+
|:books:| Repository
47+
https://github.com/scrapy/scrapy/
48+
49+
|:art:| Demo
50+
.. image:: scrapy-usage.gif
51+
:align: center
52+
:width: 100%
53+
54+
55+
tweepy
56+
------
57+
58+
|:books:| Repository
59+
https://github.com/tweepy/tweepy/
60+
61+
|:art:| Demo
62+
.. image:: tweepy-usage.gif
63+
:align: center
64+
:width: 100%
65+
66+
67+
68+
hypothesis
69+
----------
70+
71+
|:books:| Repository
72+
https://github.com/HypothesisWorks/hypothesis
73+
74+
|:art:| Demo
75+
.. image:: hypothesis-usage.gif
76+
:align: center
77+
:width: 100%
78+
79+
80+
crest
81+
-----
82+
83+
|:books:| Repository
84+
https://github.com/wave-harmonic/crest
85+
86+
|:art:| Demo
87+
.. image:: crest-usage.gif
88+
:align: center
89+
:width: 100%

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ doc = [
4949
"sphinx-notfound-page",
5050
"sphinx-autobuild",
5151
"sphinxcontrib-bibtex",
52+
"sphinxemoji",
5253
]
5354

5455
[project.urls]

0 commit comments

Comments
 (0)