Merge remote-tracking branch 'origin/docs-discus-comments'

This commit is contained in:
Roman Mogilatov 2017-02-28 22:17:43 +02:00
commit 53c8e1548a
28 changed files with 93 additions and 6 deletions

10
docs/_static/disqus.js vendored Normal file
View File

@ -0,0 +1,10 @@
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);
}})();

View File

@ -4,3 +4,6 @@
.. automodule:: dependency_injector.containers .. automodule:: dependency_injector.containers
:members: :members:
:special-members: :special-members:
.. disqus::

View File

@ -3,3 +3,6 @@
.. automodule:: dependency_injector.errors .. automodule:: dependency_injector.errors
:members: :members:
.. disqus::

View File

@ -5,3 +5,6 @@
:members: :members:
:inherited-members: :inherited-members:
:show-inheritance: :show-inheritance:
.. disqus::

View File

@ -3,3 +3,6 @@
.. automodule:: dependency_injector .. automodule:: dependency_injector
:members: VERSION :members: VERSION
.. disqus::

View File

@ -29,7 +29,8 @@ sys.path.insert(0, os.path.abspath('..'))
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = ['sphinx.ext.autodoc'] extensions = ['sphinx.ext.autodoc',
'sphinxcontrib.disqus']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -140,7 +141,7 @@ html_theme = 'default'
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = [] html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or # Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied # .htaccess) here, relative to this directory. These files are copied
@ -298,3 +299,5 @@ texinfo_documents = [
#texinfo_no_detailmenu = False #texinfo_no_detailmenu = False
autodoc_member_order = 'bysource' autodoc_member_order = 'bysource'
disqus_shortname = 'python-dependency-injector'

View File

@ -53,3 +53,6 @@ Example of declarative containers's provider injections:
.. literalinclude:: ../../examples/containers/declarative_injections.py .. literalinclude:: ../../examples/containers/declarative_injections.py
:language: python :language: python
:linenos: :linenos:
.. disqus::

View File

@ -25,3 +25,6 @@ configuration:
.. literalinclude:: ../../examples/containers/dynamic_runtime_creation.py .. literalinclude:: ../../examples/containers/dynamic_runtime_creation.py
:language: python :language: python
:linenos: :linenos:
.. disqus::

View File

@ -38,3 +38,6 @@ properties that help to work with container overridings:
:py:class:`DynamicContainer` has exactly the same functionality, except of :py:class:`DynamicContainer` has exactly the same functionality, except of
:py:func:`override` decorator. :py:func:`override` decorator.
.. disqus::

View File

@ -22,3 +22,6 @@ as well:
.. literalinclude:: ../../examples/containers/dynamic_provider_type.py .. literalinclude:: ../../examples/containers/dynamic_provider_type.py
:language: python :language: python
:linenos: :linenos:
.. disqus::

View File

@ -123,4 +123,8 @@ Listing of ``app_db_csv.py``:
:language: python :language: python
:linenos: :linenos:
.. disqus::
.. _GitHub: https://github.com/ets-labs/python-dependency-injector/tree/master/examples/miniapps/movie_lister .. _GitHub: https://github.com/ets-labs/python-dependency-injector/tree/master/examples/miniapps/movie_lister

View File

@ -71,3 +71,6 @@ Listing of ``run.py``:
.. literalinclude:: ../../examples/miniapps/services/run.py .. literalinclude:: ../../examples/miniapps/services/run.py
:language: python :language: python
:linenos: :linenos:
.. disqus::

View File

@ -129,3 +129,6 @@ using :doc:`Dependency Injector <../index>`:
.. literalinclude:: ../../examples/miniapps/engines_cars/example_ioc_containers.py .. literalinclude:: ../../examples/miniapps/engines_cars/example_ioc_containers.py
:language: python :language: python
:linenos: :linenos:
.. disqus::

View File

@ -43,3 +43,6 @@ Components of *Dependency Injector* framework could be used:
Main idea of *Dependency Injector* framework is to be useful tool for the Main idea of *Dependency Injector* framework is to be useful tool for the
right thing. right thing.
.. disqus::

View File

@ -45,3 +45,6 @@ Containers could be:
+ Overridden by each other. + Overridden by each other.
+ Copied from each other. + Copied from each other.
+ Extended. + Extended.
.. disqus::

View File

@ -116,6 +116,9 @@ And `John Munsch`_ provided absolutely Great answer:
down to eat. down to eat.
.. disqus::
.. _Dependency injection: http://en.wikipedia.org/wiki/Dependency_injection .. _Dependency injection: http://en.wikipedia.org/wiki/Dependency_injection
.. _Inversion of control: https://en.wikipedia.org/wiki/Inversion_of_control .. _Inversion of control: https://en.wikipedia.org/wiki/Inversion_of_control
.. _Dependency inversion: https://en.wikipedia.org/wiki/Dependency_inversion_principle .. _Dependency inversion: https://en.wikipedia.org/wiki/Dependency_inversion_principle

View File

@ -470,4 +470,7 @@ Previous versions
- While *Objects* was in alpha state, changes were not tracked. - While *Objects* was in alpha state, changes were not tracked.
.. disqus::
.. _Semantic versioning: http://semver.org/ .. _Semantic versioning: http://semver.org/

View File

@ -7,3 +7,6 @@ Feel free to post questions, bugs, feature requests, proposals etc. on
https://github.com/ets-labs/python-dependency-injector/issues https://github.com/ets-labs/python-dependency-injector/issues
Your feedback is quite important! Your feedback is quite important!
.. disqus::

View File

@ -40,3 +40,6 @@ Verification of currently installed version could be done using
.. _PyPi: https://pypi.python.org/pypi/dependency_injector .. _PyPi: https://pypi.python.org/pypi/dependency_injector
.. _GitHub: https://github.com/ets-labs/python-dependency-injector .. _GitHub: https://github.com/ets-labs/python-dependency-injector
.. _GitHub releases page: https://github.com/ets-labs/python-dependency-injector/releases .. _GitHub releases page: https://github.com/ets-labs/python-dependency-injector/releases
.. disqus::

View File

@ -56,3 +56,6 @@ Delegation of :py:class:`Callable` providers is the same as
:ref:`factory_providers_delegation` section for examples (with exception :ref:`factory_providers_delegation` section for examples (with exception
about using :py:class:`DelegatedCallable` instead of about using :py:class:`DelegatedCallable` instead of
:py:class:`DelegatedFactory`). :py:class:`DelegatedFactory`).
.. disqus::

View File

@ -33,3 +33,6 @@ Example:
.. literalinclude:: ../../examples/providers/custom_factory.py .. literalinclude:: ../../examples/providers/custom_factory.py
:language: python :language: python
:linenos: :linenos:
.. disqus::

View File

@ -40,3 +40,6 @@ Example:
.. literalinclude:: ../../examples/providers/external_dependency.py .. literalinclude:: ../../examples/providers/external_dependency.py
:language: python :language: python
:linenos: :linenos:
.. disqus::

View File

@ -105,3 +105,6 @@ provided type:
.. literalinclude:: ../../examples/providers/factory_provided_type.py .. literalinclude:: ../../examples/providers/factory_provided_type.py
:language: python :language: python
:linenos: :linenos:
.. disqus::

View File

@ -10,3 +10,6 @@ Example:
.. literalinclude:: ../../examples/providers/object.py .. literalinclude:: ../../examples/providers/object.py
:language: python :language: python
:linenos: :linenos:
.. disqus::

View File

@ -44,3 +44,6 @@ Example:
.. literalinclude:: ../../examples/providers/overriding_users_model.py .. literalinclude:: ../../examples/providers/overriding_users_model.py
:language: python :language: python
:linenos: :linenos:
.. disqus::

View File

@ -98,3 +98,6 @@ Example:
.. literalinclude:: ../../examples/providers/singleton_thread_locals.py .. literalinclude:: ../../examples/providers/singleton_thread_locals.py
:language: python :language: python
:linenos: :linenos:
.. disqus::

View File

@ -1,10 +1,6 @@
cython cython
tox tox
unittest2 unittest2
sphinx
sphinx_rtd_theme
sphinx_autobuild
autodoc
coverage coverage
flake8 flake8
pydocstyle pydocstyle

5
requirements-doc.txt Normal file
View File

@ -0,0 +1,5 @@
sphinx
sphinx_rtd_theme
sphinx_autobuild
sphinxcontrib-disqus
autodoc