summary refs log tree commit diff
path: root/doc/languages-frameworks/python.section.md
diff options
context:
space:
mode:
authorAlejandro Sanchez Medina <alejandrosanchzmedina@gmail.com>2023-08-21 16:01:10 +0200
committerAlejandro Sanchez Medina <alejandrosanchzmedina@gmail.com>2023-08-21 16:02:34 +0200
commit13e4891d6d2b04dc87282118694104b6c5f19dd6 (patch)
tree60671449eefa5f9d3e6c824bc4a56d89cb2c21ee /doc/languages-frameworks/python.section.md
parent91f799fc39de48fd8b8c92f54607ec159291625e (diff)
downloadnixpkgs-13e4891d6d2b04dc87282118694104b6c5f19dd6.tar
nixpkgs-13e4891d6d2b04dc87282118694104b6c5f19dd6.tar.gz
nixpkgs-13e4891d6d2b04dc87282118694104b6c5f19dd6.tar.bz2
nixpkgs-13e4891d6d2b04dc87282118694104b6c5f19dd6.tar.lz
nixpkgs-13e4891d6d2b04dc87282118694104b6c5f19dd6.tar.xz
nixpkgs-13e4891d6d2b04dc87282118694104b6c5f19dd6.tar.zst
nixpkgs-13e4891d6d2b04dc87282118694104b6c5f19dd6.zip
nixpkgs manual: doc python: render manual notes as admonitions
Diffstat (limited to 'doc/languages-frameworks/python.section.md')
-rw-r--r--doc/languages-frameworks/python.section.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/languages-frameworks/python.section.md b/doc/languages-frameworks/python.section.md
index 78b3559ac01..2ced6d69edd 100644
--- a/doc/languages-frameworks/python.section.md
+++ b/doc/languages-frameworks/python.section.md
@@ -505,7 +505,9 @@ Shortcut to setup environments with C headers/libraries and Python packages:
 nix-shell -p pythonPackages.pyramid zlib libjpeg git
 ```
 
-Note: There is a boolean value `lib.inNixShell` set to `true` if nix-shell is invoked.
+::: {.note}
+There is a boolean value `lib.inNixShell` set to `true` if nix-shell is invoked.
+:::
 
 ## User Guide {#user-guide}
 
@@ -1123,16 +1125,20 @@ command provided by the setup.py (i.e. `python setup.py test`). However,
 this is currently deprecated https://github.com/pypa/setuptools/pull/1878
 and your package should provide its own checkPhase.
 
-*NOTE:* The `checkPhase` for python maps to the `installCheckPhase` on a
+::: {.note}
+The `checkPhase` for python maps to the `installCheckPhase` on a
 normal derivation. This is due to many python packages not behaving well
 to the pre-installed version of the package. Version info, and natively
 compiled extensions generally only exist in the install directory, and
 thus can cause issues when a test suite asserts on that behavior.
+:::
 
-*NOTE:* Tests should only be disabled if they don't agree with nix
+::: {.note}
+Tests should only be disabled if they don't agree with nix
 (e.g. external dependencies, network access, flakey tests), however,
 as many tests should be enabled as possible. Failing tests can still be
 a good indication that the package is not in a valid state.
+:::
 
 #### Using pytest {#using-pytest}
 
@@ -1177,8 +1183,10 @@ filtering out tests which contain `download` or `update` in their test case name
 Only one `-k` argument is allowed, and thus a long predicate should be concatenated
 with “\\” and wrapped to the next line.
 
-*NOTE:* In pytest==6.0.1, the use of “\\” to continue a line (e.g. `-k 'not download \'`) has
+::: {.note}
+In pytest==6.0.1, the use of “\\” to continue a line (e.g. `-k 'not download \'`) has
 been removed, in this case, it's recommended to use `pytestCheckHook`.
+:::
 
 #### Using pytestCheckHook {#using-pytestcheckhook}