Skip to content

Commit a8914e5

Browse files
committed
Fix Sphinx warnings
1 parent cdd9ce5 commit a8914e5

File tree

7 files changed

+21
-20
lines changed

7 files changed

+21
-20
lines changed

docs/api/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ API Documentation
22
=================
33

44
.. toctree::
5-
:maxdepth: 2
5+
:maxdepth: 2
66

77
top-level
88
providers

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
#
7373
# This is also used if you do content translation via gettext catalogs.
7474
# Usually you set "language" from the command line for these cases.
75-
language = None
75+
language = "en"
7676

7777
# There are two options for replacing |today|: either, you set today to some
7878
# non-false value, then it is used:

docs/introduction/key_features.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Key features of the ``Dependency Injector``:
3131

3232
The framework stands on the `PEP20 (The Zen of Python) <https://www.python.org/dev/peps/pep-0020/>`_ principle:
3333

34-
.. code-block:: plain
34+
.. code-block:: text
3535
3636
Explicit is better than implicit
3737

docs/tutorials/aiohttp.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ Let's check that it works. Open another terminal session and use ``httpie``:
257257
258258
You should see:
259259

260-
.. code-block:: json
260+
.. code-block:: http
261261
262262
HTTP/1.1 200 OK
263263
Content-Length: 844
@@ -596,7 +596,7 @@ and make a request to the API in the terminal:
596596
597597
You should see:
598598

599-
.. code-block:: json
599+
.. code-block:: http
600600
601601
HTTP/1.1 200 OK
602602
Content-Length: 492

docs/tutorials/cli.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Create next structure in the project root directory. All files are empty. That's
8484

8585
Initial project layout:
8686

87-
.. code-block:: bash
87+
.. code-block:: text
8888
8989
./
9090
├── movies/
@@ -109,7 +109,7 @@ Now it's time to install the project requirements. We will use next packages:
109109

110110
Put next lines into the ``requirements.txt`` file:
111111

112-
.. code-block:: bash
112+
.. code-block:: text
113113
114114
dependency-injector
115115
pyyaml
@@ -134,7 +134,7 @@ We will create a script that creates database files.
134134
First add the folder ``data/`` in the root of the project and then add the file
135135
``fixtures.py`` inside of it:
136136

137-
.. code-block:: bash
137+
.. code-block:: text
138138
:emphasize-lines: 2-3
139139
140140
./
@@ -205,13 +205,13 @@ Now run in the terminal:
205205
206206
You should see:
207207

208-
.. code-block:: bash
208+
.. code-block:: text
209209
210210
OK
211211
212212
Check that files ``movies.csv`` and ``movies.db`` have appeared in the ``data/`` folder:
213213

214-
.. code-block:: bash
214+
.. code-block:: text
215215
:emphasize-lines: 4-5
216216
217217
./
@@ -289,7 +289,7 @@ After each step we will add the provider to the container.
289289

290290
Create the ``entities.py`` in the ``movies`` package:
291291

292-
.. code-block:: bash
292+
.. code-block:: text
293293
:emphasize-lines: 10
294294
295295
./
@@ -356,7 +356,7 @@ Let's move on to the finders.
356356

357357
Create the ``finders.py`` in the ``movies`` package:
358358

359-
.. code-block:: bash
359+
.. code-block:: text
360360
:emphasize-lines: 11
361361
362362
./
@@ -465,7 +465,7 @@ The configuration file is ready. Move on to the lister.
465465

466466
Create the ``listers.py`` in the ``movies`` package:
467467

468-
.. code-block:: bash
468+
.. code-block:: text
469469
:emphasize-lines: 12
470470
471471
./
@@ -613,7 +613,7 @@ Run in the terminal:
613613
614614
You should see:
615615

616-
.. code-block:: plain
616+
.. code-block:: text
617617
618618
Francis Lawrence movies:
619619
- Movie(title='The Hunger Games: Mockingjay - Part 2', year=2015, director='Francis Lawrence')
@@ -752,7 +752,7 @@ Run in the terminal:
752752
753753
You should see:
754754

755-
.. code-block:: plain
755+
.. code-block:: text
756756
757757
Francis Lawrence movies:
758758
- Movie(title='The Hunger Games: Mockingjay - Part 2', year=2015, director='Francis Lawrence')
@@ -868,7 +868,7 @@ Run in the terminal line by line:
868868
869869
The output should be similar for each command:
870870

871-
.. code-block:: plain
871+
.. code-block:: text
872872
873873
Francis Lawrence movies:
874874
- Movie(title='The Hunger Games: Mockingjay - Part 2', year=2015, director='Francis Lawrence')
@@ -888,7 +888,7 @@ We will use `pytest <https://docs.pytest.org/en/stable/>`_ and
888888

889889
Create ``tests.py`` in the ``movies`` package:
890890

891-
.. code-block:: bash
891+
.. code-block:: text
892892
:emphasize-lines: 13
893893
894894
./
@@ -977,7 +977,7 @@ Run in the terminal:
977977
978978
You should see:
979979

980-
.. code-block::
980+
.. code-block:: text
981981
982982
platform darwin -- Python 3.10.0, pytest-6.2.5, py-1.10.0, pluggy-1.0.0
983983
plugins: cov-3.0.0

docs/tutorials/flask.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ Now let's fill in the layout.
280280

281281
Put next into the ``base.html``:
282282

283-
.. code-block:: html
283+
.. code-block:: jinja
284284
285285
<!doctype html>
286286
<html lang="en">
@@ -313,7 +313,7 @@ And put something to the index page.
313313

314314
Put next into the ``index.html``:
315315

316-
.. code-block:: html
316+
.. code-block:: jinja
317317
318318
{% extends "base.html" %}
319319

docs/wiring.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ To inject the provider itself use ``Provide[foo.provider]``:
127127
def foo(bar_provider: Factory[Bar] = Provide[Container.bar.provider]):
128128
bar = bar_provider(argument="baz")
129129
...
130+
130131
You can also use ``Provider[foo]`` for injecting the provider itself:
131132

132133
.. code-block:: python

0 commit comments

Comments
 (0)