From 3204582143fffbe8c95af26a0acaeeb2d65ff320 Mon Sep 17 00:00:00 2001 From: Roman Mogilatov Date: Mon, 4 Apr 2016 23:40:28 +0300 Subject: [PATCH] Move introduction docs to the top level --- docs/index.rst | 2 +- docs/{main => }/introduction/di_in_python.rst | 4 ++-- docs/{main => }/introduction/index.rst | 0 docs/{main => }/introduction/key_features.rst | 0 docs/{main => }/introduction/structure.rst | 0 docs/{main => }/introduction/what_is_di.rst | 6 +++--- docs/main/changelog.rst | 4 ++++ 7 files changed, 10 insertions(+), 6 deletions(-) rename docs/{main => }/introduction/di_in_python.rst (96%) rename docs/{main => }/introduction/index.rst (100%) rename docs/{main => }/introduction/key_features.rst (100%) rename docs/{main => }/introduction/structure.rst (100%) rename docs/{main => }/introduction/what_is_di.rst (96%) diff --git a/docs/index.rst b/docs/index.rst index 3ea4ab66..e4fcde00 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -58,7 +58,7 @@ Contents .. toctree:: :maxdepth: 2 - main/introduction/index + introduction/index main/installation providers/index catalogs/index diff --git a/docs/main/introduction/di_in_python.rst b/docs/introduction/di_in_python.rst similarity index 96% rename from docs/main/introduction/di_in_python.rst rename to docs/introduction/di_in_python.rst index fb658943..335cb398 100644 --- a/docs/main/introduction/di_in_python.rst +++ b/docs/introduction/di_in_python.rst @@ -86,12 +86,12 @@ Example Let's go through next example: -.. literalinclude:: ../../../examples/ioc_di_demos/car_engine_1.py +.. literalinclude:: ../../examples/ioc_di_demos/car_engine_1.py :language: python ``Car`` **creates** an ``Engine`` during its creation. Really? Does it make more sense then creating an ``Engine`` separatelly and then **put (inject) it into** ``Car`` when ``Car`` is being created? -.. literalinclude:: ../../../examples/ioc_di_demos/car_engine_2.py +.. literalinclude:: ../../examples/ioc_di_demos/car_engine_2.py :language: python diff --git a/docs/main/introduction/index.rst b/docs/introduction/index.rst similarity index 100% rename from docs/main/introduction/index.rst rename to docs/introduction/index.rst diff --git a/docs/main/introduction/key_features.rst b/docs/introduction/key_features.rst similarity index 100% rename from docs/main/introduction/key_features.rst rename to docs/introduction/key_features.rst diff --git a/docs/main/introduction/structure.rst b/docs/introduction/structure.rst similarity index 100% rename from docs/main/introduction/structure.rst rename to docs/introduction/structure.rst diff --git a/docs/main/introduction/what_is_di.rst b/docs/introduction/what_is_di.rst similarity index 96% rename from docs/main/introduction/what_is_di.rst rename to docs/introduction/what_is_di.rst index bf57b70f..488c52bd 100644 --- a/docs/main/introduction/what_is_di.rst +++ b/docs/introduction/what_is_di.rst @@ -74,19 +74,19 @@ Example Let's go through the code of ``example.py``: -.. literalinclude:: ../../../examples/ioc_di_demos/example.py +.. literalinclude:: ../../examples/ioc_di_demos/example.py :language: python At some point, things defined above mean, that the code from ``example.py``, could look different, like in ``ioc_example.py``: -.. literalinclude:: ../../../examples/ioc_di_demos/ioc_example.py +.. literalinclude:: ../../examples/ioc_di_demos/ioc_example.py :language: python Also the code from ``ioc_example.py`` could be upgraded with inversion of control container, like in ``ioc_container_example.py``: -.. literalinclude:: ../../../examples/ioc_di_demos/ioc_container_example.py +.. literalinclude:: ../../examples/ioc_di_demos/ioc_container_example.py :language: python .. note:: diff --git a/docs/main/changelog.rst b/docs/main/changelog.rst index e6d18445..fd26bc7e 100644 --- a/docs/main/changelog.rst +++ b/docs/main/changelog.rst @@ -9,10 +9,14 @@ follows `Semantic versioning`_ Development version ------------------- + +1.15.2 +------ - [Refactoring] split ``catalogs`` module into smaller modules, ``catalogs`` module become a package. - [Refactoring] split ``providers`` module into smaller modules, ``providers`` module become a package. +- Update introduction documentation. 1.15.1 ------