diff --git a/.github/workflows/publishing.yml b/.github/workflows/publishing.yml index c8eabbab1..632475687 100644 --- a/.github/workflows/publishing.yml +++ b/.github/workflows/publishing.yml @@ -115,8 +115,8 @@ jobs: - uses: actions/setup-python@v4 with: python-version: 3.12 - - run: pip install -r requirements-doc.txt - run: pip install awscli + - run: pip install -r requirements-doc.txt - run: pip install -e . - run: (cd docs && make clean html) - run: | diff --git a/docs/_static/custom.css b/docs/_static/custom.css new file mode 100644 index 000000000..ad1125953 --- /dev/null +++ b/docs/_static/custom.css @@ -0,0 +1,9 @@ +.no-border { + border: 0 !important; + box-shadow: none !important; + -webkit-box-shadow: none !important; +} +.no-border td { + border: 0px !important; + padding: 0px 10px 0px 0px !important; +} diff --git a/docs/_static/disqus.js b/docs/_static/disqus.js deleted file mode 100644 index fbd2644f0..000000000 --- a/docs/_static/disqus.js +++ /dev/null @@ -1,11 +0,0 @@ -var disqus_shortname; -var disqus_identifier; - -$(function() { - var disqus_thread = $("#disqus_thread"); - disqus_shortname = disqus_thread.data('disqus-shortname'); - disqus_identifier = disqus_thread.data('disqus-identifier'); - var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true; - dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js'; - (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); -}); diff --git a/docs/_static/sponsor.html b/docs/_static/sponsor.html new file mode 100644 index 000000000..474f3ec09 --- /dev/null +++ b/docs/_static/sponsor.html @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 5e4769ae8..380da2da5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -33,7 +33,7 @@ extensions = [ "alabaster", "sphinx.ext.autodoc", - "sphinxcontrib.disqus", + "sphinx_disqus.disqus", ] # Add any paths that contain templates here, relative to this directory. @@ -52,7 +52,7 @@ # General information about the project. project = "Dependency Injector" -copyright = "2022, Roman Mogylatov" +copyright = "2024, Roman Mogylatov" author = "Roman Mogylatov" # The version info for the project you"re documenting, acts as replacement for @@ -147,6 +147,9 @@ # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] +html_css_files = [ + "custom.css", +] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied @@ -306,4 +309,5 @@ "description": "Dependency injection framework for Python by Roman Mogylatov", "code_font_size": "10pt", "analytics_id": "UA-67012059-1", + "donate_url": "https://github.com/sponsors/rmk135", } diff --git a/docs/examples/aiohttp.rst b/docs/examples/aiohttp.rst index a9446fe8a..7600b2828 100644 --- a/docs/examples/aiohttp.rst +++ b/docs/examples/aiohttp.rst @@ -78,4 +78,6 @@ Sources Explore the sources on the `Github `_. +.. include:: ../sponsor.rst + .. disqus:: diff --git a/docs/examples/application-multiple-containers.rst b/docs/examples/application-multiple-containers.rst index d49f999a8..4cc0921b1 100644 --- a/docs/examples/application-multiple-containers.rst +++ b/docs/examples/application-multiple-containers.rst @@ -84,4 +84,6 @@ Run the application You can find the source code and instructions for running on the `Github `_. +.. include:: ../sponsor.rst + .. disqus:: \ No newline at end of file diff --git a/docs/examples/application-single-container.rst b/docs/examples/application-single-container.rst index 2f6c1c425..526a08e1b 100644 --- a/docs/examples/application-single-container.rst +++ b/docs/examples/application-single-container.rst @@ -90,4 +90,6 @@ Run the application You can find the source code and instructions for running on the `Github `_. +.. include:: ../sponsor.rst + .. disqus:: diff --git a/docs/examples/boto3.rst b/docs/examples/boto3.rst index 8ca76724d..21d07c4bf 100644 --- a/docs/examples/boto3.rst +++ b/docs/examples/boto3.rst @@ -17,4 +17,6 @@ Listing of ``boto3_session_example.py``: .. literalinclude:: ../../examples/miniapps/boto3-session/boto3_session_example.py :language: python +.. include:: ../sponsor.rst + .. disqus:: diff --git a/docs/examples/decoupled-packages.rst b/docs/examples/decoupled-packages.rst index abb4c6ab1..12375a676 100644 --- a/docs/examples/decoupled-packages.rst +++ b/docs/examples/decoupled-packages.rst @@ -129,4 +129,6 @@ Run the application You can find the source code and instructions for running on the `Github `_. +.. include:: ../sponsor.rst + .. disqus:: diff --git a/docs/examples/django.rst b/docs/examples/django.rst index 15fa0520b..08e6e7573 100644 --- a/docs/examples/django.rst +++ b/docs/examples/django.rst @@ -94,4 +94,6 @@ Sources Explore the sources on the `Github `_. +.. include:: ../sponsor.rst + .. disqus:: diff --git a/docs/examples/fastapi-redis.rst b/docs/examples/fastapi-redis.rst index 2e120cc83..abde92898 100644 --- a/docs/examples/fastapi-redis.rst +++ b/docs/examples/fastapi-redis.rst @@ -95,4 +95,6 @@ See also: - Resource provider :ref:`resource-async-initializers` - Wiring :ref:`async-injections-wiring` +.. include:: ../sponsor.rst + .. disqus:: diff --git a/docs/examples/fastapi-sqlalchemy.rst b/docs/examples/fastapi-sqlalchemy.rst index 653fd50f0..398bc1484 100644 --- a/docs/examples/fastapi-sqlalchemy.rst +++ b/docs/examples/fastapi-sqlalchemy.rst @@ -116,4 +116,6 @@ Sources The source code is available on the `Github `_. +.. include:: ../sponsor.rst + .. disqus:: diff --git a/docs/examples/fastapi.rst b/docs/examples/fastapi.rst index eaa51b789..fcd92500b 100644 --- a/docs/examples/fastapi.rst +++ b/docs/examples/fastapi.rst @@ -76,4 +76,6 @@ Sources Explore the sources on the `Github `_. +.. include:: ../sponsor.rst + .. disqus:: diff --git a/docs/examples/flask-blueprints.rst b/docs/examples/flask-blueprints.rst index c3a8f14f1..53d7ba5fe 100644 --- a/docs/examples/flask-blueprints.rst +++ b/docs/examples/flask-blueprints.rst @@ -86,4 +86,6 @@ Sources Explore the sources on the `Github `_. +.. include:: ../sponsor.rst + .. disqus:: diff --git a/docs/examples/flask.rst b/docs/examples/flask.rst index a1a312b2d..59d84ccce 100644 --- a/docs/examples/flask.rst +++ b/docs/examples/flask.rst @@ -84,4 +84,6 @@ Sources Explore the sources on the `Github `_. +.. include:: ../sponsor.rst + .. disqus:: diff --git a/docs/examples/sanic.rst b/docs/examples/sanic.rst index 3688e80f6..5eca88d3d 100644 --- a/docs/examples/sanic.rst +++ b/docs/examples/sanic.rst @@ -77,4 +77,6 @@ Sources Explore the sources on the `Github `_. +.. include:: ../sponsor.rst + .. disqus:: diff --git a/docs/index.rst b/docs/index.rst index 93203043b..33b6e9b03 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,11 +9,11 @@ Dependency Injector --- Dependency injection framework for Python :description: Dependency Injector is a dependency injection framework for Python. It helps to maintain you application structure. It was designed to be unified, developer-friendly - tool that helps to implement dependency injection design - pattern in formal, pretty, Pythonic way. Dependency Injector - provides implementations of such popular design patterns - like IoC container, Factory and Singleton. Dependency - Injector providers are implemented as C extension types + tool that helps to implement dependency injection design + pattern in formal, pretty, Pythonic way. Dependency Injector + provides implementations of such popular design patterns + like IoC container, Factory and Singleton. Dependency + Injector providers are implemented as C extension types using Cython. .. _index: diff --git a/docs/introduction/di_in_python.rst b/docs/introduction/di_in_python.rst index 5e3008404..08d911b16 100644 --- a/docs/introduction/di_in_python.rst +++ b/docs/introduction/di_in_python.rst @@ -310,4 +310,6 @@ A few useful links related to a dependency injection design pattern for further + https://github.com/ets-labs/python-dependency-injector + https://pypi.org/project/dependency-injector/ +.. include:: ../sponsor.rst + .. disqus:: diff --git a/docs/main/changelog.rst b/docs/main/changelog.rst index f32892104..37cbd7fb9 100644 --- a/docs/main/changelog.rst +++ b/docs/main/changelog.rst @@ -7,6 +7,11 @@ that were made in every particular version. From version 0.7.6 *Dependency Injector* framework strictly follows `Semantic versioning`_ +4.42.0 +-------- +- Promote release ``4.42.0b1`` to a production release. +- Fix the Disqus comment widget. + 4.42.0b1 -------- diff --git a/docs/sponsor.rst b/docs/sponsor.rst new file mode 100644 index 000000000..590abd152 --- /dev/null +++ b/docs/sponsor.rst @@ -0,0 +1,7 @@ +.. list-table:: + :class: no-border + :align: left + + * - Sponsor the project on GitHub: + - .. raw:: html + :file: _static/sponsor.html diff --git a/docs/tutorials/aiohttp.rst b/docs/tutorials/aiohttp.rst index f77bb4d88..57b1c9599 100644 --- a/docs/tutorials/aiohttp.rst +++ b/docs/tutorials/aiohttp.rst @@ -859,4 +859,6 @@ What's next? - Know more about the :ref:`providers` - Go to the :ref:`contents` +.. include:: ../sponsor.rst + .. disqus:: diff --git a/docs/tutorials/asyncio-daemon.rst b/docs/tutorials/asyncio-daemon.rst index 5e641739f..0c6d552a5 100644 --- a/docs/tutorials/asyncio-daemon.rst +++ b/docs/tutorials/asyncio-daemon.rst @@ -1028,4 +1028,6 @@ What's next? - Know more about the :ref:`providers` - Go to the :ref:`contents` +.. include:: ../sponsor.rst + .. disqus:: diff --git a/docs/tutorials/cli.rst b/docs/tutorials/cli.rst index 4f33d31ed..8b108e08e 100644 --- a/docs/tutorials/cli.rst +++ b/docs/tutorials/cli.rst @@ -1034,4 +1034,6 @@ What's next? - Know more about the :ref:`providers` - Go to the :ref:`contents` +.. include:: ../sponsor.rst + .. disqus:: diff --git a/docs/tutorials/flask.rst b/docs/tutorials/flask.rst index a0075502f..8c22aa5a0 100644 --- a/docs/tutorials/flask.rst +++ b/docs/tutorials/flask.rst @@ -998,5 +998,6 @@ What's next? - Know more about the :ref:`providers` - Go to the :ref:`contents` +.. include:: ../sponsor.rst .. disqus:: diff --git a/requirements-doc.txt b/requirements-doc.txt index 292c0cba9..1c520497c 100644 --- a/requirements-doc.txt +++ b/requirements-doc.txt @@ -4,6 +4,6 @@ sphinx # TODO: unpin jinja2 after sphinx update to 4+ jinja2 --e git+https://github.com/rmk135/sphinxcontrib-disqus.git#egg=sphinxcontrib-disqus +sphinx-disqus==1.3.0 -r requirements-ext.txt diff --git a/src/dependency_injector/__init__.py b/src/dependency_injector/__init__.py index 42f7dbe24..a179668b0 100644 --- a/src/dependency_injector/__init__.py +++ b/src/dependency_injector/__init__.py @@ -1,6 +1,6 @@ """Top-level package.""" -__version__ = "4.42.0b1" +__version__ = "4.42.0" """Version number. :type: str