Merge pull request #1195 from mlco2/release/3.2.7

benoit-cty · web-flow · commit 08dcc1b33097 · 2026-05-17T15:12:04.000+02:00
Release 3.2.7
diff --git a/codecarbon/_version.py b/codecarbon/_version.py
@@ -1 +1 @@
-__version__ = "3.2.6"
+__version__ = "3.2.7"
diff --git a/docs/explanation/why.md b/docs/explanation/why.md
@@ -41,4 +41,4 @@ codecarbon monitor -- python train.py
 
 ## CO₂-equivalents
 
-This package enables developers to track emissions, measured as kilograms of CO₂-equivalents (CO₂eq) in order to estimate the carbon footprint of their work. We use *CO₂-equivalents [CO₂eq]*, which is a standardized measure used to express the global warming potential of various greenhouse gases: the amount of CO₂ that would have the equivalent global warming impact. For computing, which emits CO₂ via the electricity it consumes, carbon emissions are measured in kilograms of CO₂-equivalent per kilowatt-hour. Electricity is generated as part of the broader electrical grid by combusting fossil fuels, for example.
+This package enables developers to track emissions, measured as kilograms of CO₂-equivalents (CO₂eq) in order to estimate the carbon footprint of their work. We use *CO₂-equivalents (CO₂eq)*, which is a standardized measure used to express the global warming potential of various greenhouse gases: the amount of CO₂ that would have the equivalent global warming impact. For computing, which emits CO₂ via the electricity it consumes, carbon emissions are measured in kilograms of CO₂-equivalent per kilowatt-hour. Electricity is generated as part of the broader electrical grid by combusting fossil fuels, for example.
diff --git a/docs/how-to/code-of-conduct.md b/docs/how-to/code-of-conduct.md
@@ -54,7 +54,7 @@ Community Moderators take reports of violations seriously and will make every ef
 
 ## Addressing and Repairing Harm
 
-**[NOTE: The remedies and repairs outlined below are suggestions based on best practices in code of conduct enforcement. If your community has its own established enforcement process, be sure to edit this section to describe your own policies.]**
+**NOTE: The remedies and repairs outlined below are suggestions based on best practices in code of conduct enforcement. If your community has its own established enforcement process, be sure to edit this section to describe your own policies.**
 
 If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
 
diff --git a/docs/how-to/contributing.md b/docs/how-to/contributing.md
@@ -5,21 +5,21 @@
 <!-- TOC start (generated with https://github.com/derlin/bitdowntoc) -->
 
 - [Contributing to Code Carbon](#contributing-to-code-carbon)
-  - [ Have a Question?](#-have-a-question)
-  - [ Found a Bug?](#-found-a-bug)
-  - [ Have a Feature Request?](#-have-a-feature-request)
+  - [Have a Question?](#have-a-question)
+  - [Found a Bug?](#found-a-bug)
+  - [Have a Feature Request?](#have-a-feature-request)
   - [Alternative ways of contributing](#alternative-ways-of-contributing)
-  - [ Ready to Contribute!](#-ready-to-contribute)
+  - [Ready to Contribute!](#ready-to-contribute)
     - [Installation](#installation)
     - [Some UV commands](#some-uv-commands)
     - [Tests](#tests)
     - [Stress your computer](#stress-your-computer)
     - [Update all dependencies](#update-all-dependencies)
     - [Branching and Pull Requests](#branching-and-pull-requests)
     - [Debug in VS Code](#debug-in-vs-code)
-    - [Coding style \&\& Linting](#coding-style--linting)
+    - [Coding style \&\& Linting](#coding-style-linting)
     - [Dependencies management](#dependencies-management)
-    - [Build Documentation 🖨️](#build-documentation-️)
+    - [Build Documentation 🖨️](#build-documentation)
     - [Release process](#release-process)
       - [Test the build in Docker](#test-the-build-in-docker)
   - [API and Dashboard](#api-and-dashboard)
@@ -45,13 +45,13 @@ Please see the [FAQ](https://docs.codecarbon.io/latest/explanation/faq/) for que
 <!-- TOC --><a name="found-a-bug"></a>
 ## </a> Found a Bug?
 
-If you've identified a bug in `codecarbon`, please [submit an issue](#issue) to the GitHub repo: [mlco2/codecarbon](https://github.com/mlco2/codecarbon/issues/new). Please also feel free to submit a PR with a fix for the bug!
+If you've identified a bug in `codecarbon`, please [submit an issue](https://github.com/mlco2/codecarbon/issues/new) to the GitHub repo: [mlco2/codecarbon](https://github.com/mlco2/codecarbon/issues/new). Please also feel free to submit a PR with a fix for the bug!
 
 
 <!-- TOC --><a name="have-a-feature-request"></a>
 ## </a> Have a Feature Request?
 
-Feel free to describe your request by [submitting an issue](#issue) documenting the feature (with its intent) and a PR with a proposed implementation of the feature.
+Feel free to describe your request by [submitting an issue](https://github.com/mlco2/codecarbon/issues/new) documenting the feature (with its intent) and a PR with a proposed implementation of the feature.
 
 Before submitting a new issue, please search the issues to make sure there isn't a similar issue already.
 New issues can be created within the [GitHub repo](https://github.com/mlco2/codecarbon/issues/new).
@@ -136,7 +136,7 @@ For example: `uv run python -m unittest tests.test_energy.TestEnergy.test_wrapar
 
 Some tests will fail if you do not set *CODECARBON_ALLOW_MULTIPLE_RUNS* with `export CODECARBON_ALLOW_MULTIPLE_RUNS=True` before running test manually.
 
-To test the API, see [how to deploy it](#local_deployement) first.
+To test the API, see [how to run it locally](#api) first.
 
 Core and external classes are unit tested, with one test file per class. Most pull requests are expected to contain either new tests or test updates. If you are unusure what to test / how to test it, please put it in the pull request description and the maintainers will help you.
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -9,7 +9,6 @@ edit_uri: edit/master/docs/
 copyright: "&copy; CodeCarbon"
 
 theme:
-  name: zensical
   favicon: images/favicon.ico
   logo: images/codecarbon-logo.svg
   palette:
diff --git a/pyproject.toml b/pyproject.toml
@@ -97,7 +97,9 @@ dev = [
     "scikit-learn",  # For documentation examples and tests
 ]
 doc = [
+  "requests",
   "setuptools",
+  "taskipy",
   "zensical",
   "mike",
   "mkdocstrings[python]>=0.26",
@@ -152,7 +154,7 @@ docs-check-drift = "python scripts/check-docs-drift.py"
 carbonboard = "python codecarbon/viz/carbonboard.py"
 
 [tool.bumpver]
-current_version = "3.2.6"
+current_version = "3.2.7"
 version_pattern = "MAJOR.MINOR.PATCH[_TAGNUM]"
 
 [tool.bumpver.file_patterns]
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = "3.2.6"`
	`1`	`+__version__ = "3.2.7"`
Original file line number	Diff line number	Diff line change
`@@ -41,4 +41,4 @@ codecarbon monitor -- python train.py`
`41`	`41`
`42`	`42`	`## CO₂-equivalents`
`43`	`43`
`44`		-This package enables developers to track emissions, measured as kilograms of CO₂-equivalents (CO₂eq) in order to estimate the carbon footprint of their work. We use CO₂-equivalents [CO₂eq], which is a standardized measure used to express the global warming potential of various greenhouse gases: the amount of CO₂ that would have the equivalent global warming impact. For computing, which emits CO₂ via the electricity it consumes, carbon emissions are measured in kilograms of CO₂-equivalent per kilowatt-hour. Electricity is generated as part of the broader electrical grid by combusting fossil fuels, for example.
	`44`	+This package enables developers to track emissions, measured as kilograms of CO₂-equivalents (CO₂eq) in order to estimate the carbon footprint of their work. We use CO₂-equivalents (CO₂eq), which is a standardized measure used to express the global warming potential of various greenhouse gases: the amount of CO₂ that would have the equivalent global warming impact. For computing, which emits CO₂ via the electricity it consumes, carbon emissions are measured in kilograms of CO₂-equivalent per kilowatt-hour. Electricity is generated as part of the broader electrical grid by combusting fossil fuels, for example.