ets-labs/python-dependency-injector
1
1
Fork 0
mirror of https://github.com/ets-labs/python-dependency-injector.git synced 2025-07-17 03:22:25 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix Sphinx warnings

Browse Source
This commit is contained in:
ZipFile 2025-06-01 18:08:37 +00:00
parent cdd9ce5048
commit a8914e54e0
7 changed files with 21 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/conf.py
View File

@ -72,7 +72,7 @@ release = version
# #
# This is also used if you do content translation via gettext catalogs. # This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases. # Usually you set "language" from the command line for these cases.
language = None language = "en"
# There are two options for replacing |today|: either, you set today to some # There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used: # non-false value, then it is used:

2
docs/introduction/key_features.rst
View File

@ -31,7 +31,7 @@ Key features of the ``Dependency Injector``:
The framework stands on the `PEP20 (The Zen of Python) <https://www.python.org/dev/peps/pep-0020/>`_ principle: The framework stands on the `PEP20 (The Zen of Python) <https://www.python.org/dev/peps/pep-0020/>`_ principle:
.. code-block:: plain .. code-block:: text
Explicit is better than implicit Explicit is better than implicit

4
docs/tutorials/aiohttp.rst
View File

@ -257,7 +257,7 @@ Let's check that it works. Open another terminal session and use ``httpie``:
You should see: You should see:
.. code-block:: json .. code-block:: http
HTTP/1.1 200 OK HTTP/1.1 200 OK
Content-Length: 844 Content-Length: 844
@ -596,7 +596,7 @@ and make a request to the API in the terminal:
You should see: You should see:
.. code-block:: json .. code-block:: http
HTTP/1.1 200 OK HTTP/1.1 200 OK
Content-Length: 492 Content-Length: 492

26
docs/tutorials/cli.rst
View File

@ -84,7 +84,7 @@ Create next structure in the project root directory. All files are empty. That's
Initial project layout: Initial project layout:
.. code-block:: bash .. code-block:: text
./ ./
├── movies/ ├── movies/
@ -109,7 +109,7 @@ Now it's time to install the project requirements. We will use next packages:
Put next lines into the ``requirements.txt`` file: Put next lines into the ``requirements.txt`` file:
.. code-block:: bash .. code-block:: text
dependency-injector dependency-injector
pyyaml pyyaml
@ -134,7 +134,7 @@ We will create a script that creates database files.
First add the folder ``data/`` in the root of the project and then add the file First add the folder ``data/`` in the root of the project and then add the file
``fixtures.py`` inside of it: ``fixtures.py`` inside of it:
.. code-block:: bash .. code-block:: text
:emphasize-lines: 2-3 :emphasize-lines: 2-3
./ ./
@ -205,13 +205,13 @@ Now run in the terminal:
You should see: You should see:
.. code-block:: bash .. code-block:: text
OK OK
Check that files ``movies.csv`` and ``movies.db`` have appeared in the ``data/`` folder: Check that files ``movies.csv`` and ``movies.db`` have appeared in the ``data/`` folder:
.. code-block:: bash .. code-block:: text
:emphasize-lines: 4-5 :emphasize-lines: 4-5
./ ./
@ -289,7 +289,7 @@ After each step we will add the provider to the container.
Create the ``entities.py`` in the ``movies`` package: Create the ``entities.py`` in the ``movies`` package:
.. code-block:: bash .. code-block:: text
:emphasize-lines: 10 :emphasize-lines: 10
./ ./
@ -356,7 +356,7 @@ Let's move on to the finders.
Create the ``finders.py`` in the ``movies`` package: Create the ``finders.py`` in the ``movies`` package:
.. code-block:: bash .. code-block:: text
:emphasize-lines: 11 :emphasize-lines: 11
./ ./
@ -465,7 +465,7 @@ The configuration file is ready. Move on to the lister.
Create the ``listers.py`` in the ``movies`` package: Create the ``listers.py`` in the ``movies`` package:
.. code-block:: bash .. code-block:: text
:emphasize-lines: 12 :emphasize-lines: 12
./ ./
@ -613,7 +613,7 @@ Run in the terminal:
You should see: You should see:
.. code-block:: plain .. code-block:: text
Francis Lawrence movies: Francis Lawrence movies:
- Movie(title='The Hunger Games: Mockingjay - Part 2', year=2015, director='Francis Lawrence') - Movie(title='The Hunger Games: Mockingjay - Part 2', year=2015, director='Francis Lawrence')
@ -752,7 +752,7 @@ Run in the terminal:
You should see: You should see:
.. code-block:: plain .. code-block:: text
Francis Lawrence movies: Francis Lawrence movies:
- Movie(title='The Hunger Games: Mockingjay - Part 2', year=2015, director='Francis Lawrence') - Movie(title='The Hunger Games: Mockingjay - Part 2', year=2015, director='Francis Lawrence')
@ -868,7 +868,7 @@ Run in the terminal line by line:
The output should be similar for each command: The output should be similar for each command:
.. code-block:: plain .. code-block:: text
Francis Lawrence movies: Francis Lawrence movies:
- Movie(title='The Hunger Games: Mockingjay - Part 2', year=2015, director='Francis Lawrence') - 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
Create ``tests.py`` in the ``movies`` package: Create ``tests.py`` in the ``movies`` package:
.. code-block:: bash .. code-block:: text
:emphasize-lines: 13 :emphasize-lines: 13
./ ./
@ -977,7 +977,7 @@ Run in the terminal:
You should see: You should see:
.. code-block:: .. code-block:: text
platform darwin -- Python 3.10.0, pytest-6.2.5, py-1.10.0, pluggy-1.0.0 platform darwin -- Python 3.10.0, pytest-6.2.5, py-1.10.0, pluggy-1.0.0
plugins: cov-3.0.0 plugins: cov-3.0.0

4
docs/tutorials/flask.rst
View File

@ -280,7 +280,7 @@ Now let's fill in the layout.
Put next into the ``base.html``: Put next into the ``base.html``:
.. code-block:: html .. code-block:: jinja
<!doctype html> <!doctype html>
<html lang="en"> <html lang="en">
@ -313,7 +313,7 @@ And put something to the index page.
Put next into the ``index.html``: Put next into the ``index.html``:
.. code-block:: html .. code-block:: jinja
{% extends "base.html" %} {% extends "base.html" %}

1
docs/wiring.rst
View File

@ -127,6 +127,7 @@ To inject the provider itself use ``Provide[foo.provider]``:
def foo(bar_provider: Factory[Bar] = Provide[Container.bar.provider]): def foo(bar_provider: Factory[Bar] = Provide[Container.bar.provider]):
bar = bar_provider(argument="baz") bar = bar_provider(argument="baz")
... ...
You can also use ``Provider[foo]`` for injecting the provider itself: You can also use ``Provider[foo]`` for injecting the provider itself:
.. code-block:: python .. code-block:: python