Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 17ecbb66283862d6a160c35238add531
config: 6a3f5c9be9eaecb995e0506550ec299d
tags: 645f666f9bcd5a90fca523b33c5a78b7
16 changes: 16 additions & 0 deletions docs/_sources/installation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
Installing CodeCarbon
=====================


From PyPi repository
--------------------

Expand Down Expand Up @@ -57,3 +58,18 @@ The following packages are used by the CodeCarbon package, and will be installed


Please refer to `pyproject.toml <https://github.com/mlco2/codecarbon/blob/master/pyproject.toml>`_ for the latest list of the packages used.

(Non-Python users) Standalone installer
---------------------------------------
If you are not using Python but you still would like to run CodeCarbon (for instance to use the :ref:`CodeCarbon Command line <usage-command-line>`)), we provide a standalone installer to download and install CodeCarbon on your machine.

Use curl to download the script and execute it with sh:

.. code-block:: bash

curl -LsSf https://codecarbon.io/scripts/install.sh | sh
or for Windows users, using powershell:

.. code-block:: powershell

powershell -ExecutionPolicy ByPass -c "irm https://codecarbon.io/scripts/install.ps1 | iex"
2 changes: 2 additions & 0 deletions docs/_sources/usage.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Online Mode
When the environment has internet access, the ``EmissionsTracker`` object or the ``track_emissions`` decorator can be used, which has
the ``offline`` parameter set to ``False`` by default.

.. _usage-command-line:

Command line
~~~~~~~~~~~~

Expand Down
8 changes: 8 additions & 0 deletions docs/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -741,6 +741,14 @@ abbr, acronym {
cursor: help;
}

.translated {
background-color: rgba(207, 255, 207, 0.2)
}

.untranslated {
background-color: rgba(255, 207, 207, 0.2)
}

/* -- code displays --------------------------------------------------------- */

pre {
Expand Down
11 changes: 5 additions & 6 deletions docs/_static/doctools.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ const Documentation = {
Object.assign(Documentation.TRANSLATIONS, catalog.messages);
Documentation.PLURAL_EXPR = new Function(
"n",
`return (${catalog.plural_expr})`,
`return (${catalog.plural_expr})`
);
Documentation.LOCALE = catalog.locale;
},
Expand Down Expand Up @@ -89,7 +89,7 @@ const Documentation = {

const togglerElements = document.querySelectorAll("img.toggler");
togglerElements.forEach((el) =>
el.addEventListener("click", (event) => toggler(event.currentTarget)),
el.addEventListener("click", (event) => toggler(event.currentTarget))
);
togglerElements.forEach((el) => (el.style.display = ""));
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
Expand All @@ -98,15 +98,14 @@ const Documentation = {
initOnKeyListeners: () => {
// only install a listener if it is really needed
if (
!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS
&& !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
)
return;

document.addEventListener("keydown", (event) => {
// bail for input elements
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName))
return;
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
// bail with special keys
if (event.altKey || event.ctrlKey || event.metaKey) return;

Expand Down
193 changes: 186 additions & 7 deletions docs/_static/language_data.js

Large diffs are not rendered by default.

Loading
Loading