📝 Move logging to Python basics

cusyio · Dec 7, 2024 · e6b8b3b · e6b8b3b
1 parent 679d91d
commit e6b8b3b
Show file tree

Hide file tree

Showing 12 changed files with 18 additions and 982 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -44,6 +44,7 @@ Added
 Removed
 ~~~~~~~
 
+* 📝 Move logging to Python basics
 * ✏️ Remove link to Objectivity/DB
 * 📝 Move SOLID principles to Python Basics
 

diff --git a/docs/intro.rst b/docs/intro.rst
@@ -52,9 +52,9 @@ From Chapter 2, the tutorial follows the prototype of a research project:
     code should be :doc:`packed into programme libraries <productive/packaging>`
     with :doc:`documentation <productive/documenting>`, :doc:`licence(s)
     <productive/licensing>`, :doc:`tests <productive/testing>` and
-    :doc:`logging <productive/logging/index>`. Finally, the chapter includes
-    advice on :doc:`improving code quality <productive/qa/index>` and
-    :doc:`secure operation <productive/security>`.
+    :doc:`python-basics:logging/index`. Finally, the chapter includes advice on
+    :doc:`improving code quality <productive/qa/index>` and :doc:`secure
+    operation <productive/security>`.
 #.  :doc:`web/index` can either generate dashboards from Jupyter notebooks or
     require more comprehensive application logic, such as demonstrated in
     :doc:`pyviz:bokeh/embedding-export/flask`, or provide data via a `RESTful

diff --git a/docs/productive/envs/uv/docker.rst b/docs/productive/envs/uv/docker.rst
@@ -5,8 +5,8 @@ We divide our Docker workflow into different layers. This allows us to provide
 new builds more quickly. We start with the layers that change the least so that
 we can cache the artefacts for as long as possible. This is also the reason why
 we keep the installations of the dependencies from :file:`uv.lock` and the
-installation of our :doc:`application <python-basics:apps>` strictly separate –
-our code probably changes faster than that of the dependencies.
+installation of our :doc:`application <python-basics:packs/apps>` strictly
+separate – our code probably changes faster than that of the dependencies.
 
 .. seealso::
    * `Order your layers
@@ -195,7 +195,7 @@ our code probably changes faster than that of the dependencies.
 
    Lines 29–30:
        If your application is not a :doc:`Python package
-       <python-basics:libs/distribution>` installed with ``uv sync``, you must
+       <python-basics:packs/distribution>` installed with ``uv sync``, you must
        copy your application into the container here.
 
    Line 32:

diff --git a/docs/productive/envs/uv/index.rst b/docs/productive/envs/uv/index.rst
@@ -5,7 +5,7 @@
 
 Both the :ref:`installation of uv  <python-basics:uv>` and the creation of file
 structures for :ref:`libraries <python-basics:uv-package-structure>` or
-:doc:`python-basics:apps` are already described in our
+:doc:`python-basics:packs/apps` are already described in our
 :doc:`python-basics:index` tutorial.
 
 .. _inline-script-metadata:

diff --git a/docs/productive/git/advanced/gitlab/ci-cd.rst b/docs/productive/git/advanced/gitlab/ci-cd.rst
@@ -67,7 +67,7 @@ Jobs
     .. seealso::
        * `GitLab Docs: Jobs
          <https://docs.gitlab.com/ee/ci/jobs/index.html>`_
-       * :doc:`python-basics:libs/cibuildwheel`
+       * :doc:`python-basics:packs/cibuildwheel`
        * :ref:`pre-commit Hooks <pre-commit-in-gitlab-ci>`
        * :ref:`Licensing <reuse-in-gitlab-ci>`
 

diff --git a/docs/productive/index.rst b/docs/productive/index.rst
@@ -33,8 +33,8 @@ There are various tools that support you in creating shareable products. These
 can be tools on the one hand for the :doc:`versioning of the source code
 <git/index>` and the :doc:`training data <dvc/index>` as well as for the
 reproducibility of the :doc:`execution environments <envs/index>`, on the other
-hand for :doc:`testing`, :doc:`logging/index`, :doc:`documenting <documenting>`
-and :doc:`creating packages <python-basics:libs/index>`.
+hand for :doc:`testing`, :doc:`python-basics:logging/index`, :doc:`documenting
+<documenting>` and :doc:`creating packages <python-basics:libs/index>`.
 
 .. seealso::
 
@@ -63,6 +63,6 @@ and :doc:`creating packages <python-basics:libs/index>`.
     licensing
     cite/index
     testing
-    logging/index
+    logging
     qa/index
     security
diff --git a/docs/productive/licensing.rst b/docs/productive/licensing.rst
@@ -487,7 +487,7 @@ Python package metadata
 
 With :pep:`658` the :file:`METADATA` file from distributions becomes available
 in the :pep:`503` repository API on :term:`PyPI`. This allows the metadata of
-:doc:`distribution packages <python-basics:libs/distribution>` to be analysed
+:doc:`distribution packages <python-basics:packs/distribution>` to be analysed
 without having to download the whole package.
 
 In Python packages there are other fields where licence information is stored,

diff --git a/docs/productive/logging.rst b/docs/productive/logging.rst
@@ -0,0 +1,5 @@
+Logging
+=======
+
+You can find an introduction to logging in our
+:doc:`python-basics:logging/index`.
diff --git a/docs/productive/logging/development.ini b/docs/productive/logging/development.ini
-Original file line number
+Diff line change
@@ Expand Up / @@ -44,6 +44,7 @@ Added @@
     Removed
     ~~~~~~~
+    * 📝 Move logging to Python basics
     * ✏️ Remove link to Objectivity/DB
     * 📝 Move SOLID principles to Python Basics
@@ Expand Down @@