Skip to content

Commit dd924b0

Browse files
committed
📝 Move logging to Python basics
1 parent f2e08c5 commit dd924b0

File tree

12 files changed

+18
-982
lines changed

12 files changed

+18
-982
lines changed

CHANGELOG.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Added
4444
Removed
4545
~~~~~~~
4646

47+
* 📝 Move logging to Python basics
4748
* ✏️ Remove link to Objectivity/DB
4849
* 📝 Move SOLID principles to Python Basics
4950

docs/intro.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ From Chapter 2, the tutorial follows the prototype of a research project:
5252
code should be :doc:`packed into programme libraries <productive/packaging>`
5353
with :doc:`documentation <productive/documenting>`, :doc:`licence(s)
5454
<productive/licensing>`, :doc:`tests <productive/testing>` and
55-
:doc:`logging <productive/logging/index>`. Finally, the chapter includes
56-
advice on :doc:`improving code quality <productive/qa/index>` and
57-
:doc:`secure operation <productive/security>`.
55+
:doc:`python-basics:logging/index`. Finally, the chapter includes advice on
56+
:doc:`improving code quality <productive/qa/index>` and :doc:`secure
57+
operation <productive/security>`.
5858
#. :doc:`web/index` can either generate dashboards from Jupyter notebooks or
5959
require more comprehensive application logic, such as demonstrated in
6060
:doc:`pyviz:bokeh/embedding-export/flask`, or provide data via a `RESTful

docs/productive/envs/uv/docker.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ We divide our Docker workflow into different layers. This allows us to provide
55
new builds more quickly. We start with the layers that change the least so that
66
we can cache the artefacts for as long as possible. This is also the reason why
77
we keep the installations of the dependencies from :file:`uv.lock` and the
8-
installation of our :doc:`application <python-basics:apps>` strictly separate –
9-
our code probably changes faster than that of the dependencies.
8+
installation of our :doc:`application <python-basics:packs/apps>` strictly
9+
separate – our code probably changes faster than that of the dependencies.
1010

1111
.. seealso::
1212
* `Order your layers
@@ -195,7 +195,7 @@ our code probably changes faster than that of the dependencies.
195195

196196
Lines 29–30:
197197
If your application is not a :doc:`Python package
198-
<python-basics:libs/distribution>` installed with ``uv sync``, you must
198+
<python-basics:packs/distribution>` installed with ``uv sync``, you must
199199
copy your application into the container here.
200200

201201
Line 32:

docs/productive/envs/uv/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Both the :ref:`installation of uv <python-basics:uv>` and the creation of file
77
structures for :ref:`libraries <python-basics:uv-package-structure>` or
8-
:doc:`python-basics:apps` are already described in our
8+
:doc:`python-basics:packs/apps` are already described in our
99
:doc:`python-basics:index` tutorial.
1010

1111
.. _inline-script-metadata:

docs/productive/git/advanced/gitlab/ci-cd.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Jobs
6767
.. seealso::
6868
* `GitLab Docs: Jobs
6969
<https://docs.gitlab.com/ee/ci/jobs/index.html>`_
70-
* :doc:`python-basics:libs/cibuildwheel`
70+
* :doc:`python-basics:packs/cibuildwheel`
7171
* :ref:`pre-commit Hooks <pre-commit-in-gitlab-ci>`
7272
* :ref:`Licensing <reuse-in-gitlab-ci>`
7373

docs/productive/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ There are various tools that support you in creating shareable products. These
3333
can be tools on the one hand for the :doc:`versioning of the source code
3434
<git/index>` and the :doc:`training data <dvc/index>` as well as for the
3535
reproducibility of the :doc:`execution environments <envs/index>`, on the other
36-
hand for :doc:`testing`, :doc:`logging/index`, :doc:`documenting <documenting>`
37-
and :doc:`creating packages <python-basics:libs/index>`.
36+
hand for :doc:`testing`, :doc:`python-basics:logging/index`, :doc:`documenting
37+
<documenting>` and :doc:`creating packages <python-basics:libs/index>`.
3838

3939
.. seealso::
4040

@@ -63,6 +63,6 @@ and :doc:`creating packages <python-basics:libs/index>`.
6363
licensing
6464
cite/index
6565
testing
66-
logging/index
66+
logging
6767
qa/index
6868
security

docs/productive/licensing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ Python package metadata
487487

488488
With :pep:`658` the :file:`METADATA` file from distributions becomes available
489489
in the :pep:`503` repository API on :term:`PyPI`. This allows the metadata of
490-
:doc:`distribution packages <python-basics:libs/distribution>` to be analysed
490+
:doc:`distribution packages <python-basics:packs/distribution>` to be analysed
491491
without having to download the whole package.
492492

493493
In Python packages there are other fields where licence information is stored,

docs/productive/logging.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Logging
2+
=======
3+
4+
You can find an introduction to logging in our
5+
:doc:`python-basics:logging/index`.

docs/productive/logging/development.ini

Lines changed: 0 additions & 25 deletions
This file was deleted.

0 commit comments

Comments
 (0)