Skip to content

Commit 876ed0f

Browse files
author
benoit-cty
committed
Build doc
1 parent 85eca64 commit 876ed0f

24 files changed

Lines changed: 51 additions & 51 deletions

docs/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 5444747ce17d7942890303a4e6aa98ce
3+
config: 1179cfac2a69f75fdb97976cfa9a706e
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_sources/parameters.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ Input Parameters
3131
* - log_level
3232
- | Global codecarbon log level (by order of verbosity): "debug", "info" (default),
3333
| "warning", "error", or "critical"
34-
* - co2_signal_api_token
35-
- | API token for co2signal.com (requires sign-up for free beta)
34+
* - electricitymaps_api_token
35+
- | API token for electricitymaps.com (formerly co2signal.com)
3636
* - pue
3737
- | PUE (Power Usage Effectiveness) of the data center
3838
| where the experiment is being run.

docs/_sources/usage.rst.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ For instance:
215215
[codecarbon]
216216
save_to_file = true
217217
output_dir = /Users/victor/emissions
218-
co2_signal_api_token=script-overwrite
218+
electricitymaps_api_token=script-overwrite
219219
experiment_id = 235b1da5-aaaa-aaaa-aaaa-893681599d2c
220220
log_level = DEBUG
221221
tracking_mode = process
@@ -235,7 +235,7 @@ For instance:
235235
EmissionsTracker(
236236
api_call_interval=4,
237237
save_to_api=True,
238-
co2_signal_api_token="some-token")
238+
electricitymaps_api_token="some-token")
239239
240240
Yields attributes:
241241

@@ -251,7 +251,7 @@ Yields attributes:
251251
"tracking_mode": "process", # from ./.codecarbon.config
252252
"emissions_endpoint": "localhost:7777", # from ~/.codecarbon.config
253253
"output_dir": "/Users/victor/emissions", # from ./.codecarbon.config
254-
"co2_signal_api_token": "some-token", # from script (override ./.codecarbon.config)
254+
"electricitymaps_api_token": "some-token", # from script (override ./.codecarbon.config)
255255
"gpu_ids": [0, 1], # from environment variable
256256
}
257257

docs/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '3.1.0',
2+
VERSION: '3.1.1',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

docs/advanced_installation.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Advanced Installation &mdash; CodeCarbon 3.1.0 documentation</title>
9+
<title>Advanced Installation &mdash; CodeCarbon 3.1.1 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=dd1205ac"></script>
16+
<script src="_static/documentation_options.js?v=796a81b5"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>

docs/api.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>CodeCarbon API &mdash; CodeCarbon 3.1.0 documentation</title>
9+
<title>CodeCarbon API &mdash; CodeCarbon 3.1.1 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=dd1205ac"></script>
16+
<script src="_static/documentation_options.js?v=796a81b5"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>

docs/comet.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Comet Integration &mdash; CodeCarbon 3.1.0 documentation</title>
9+
<title>Comet Integration &mdash; CodeCarbon 3.1.1 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=dd1205ac"></script>
16+
<script src="_static/documentation_options.js?v=796a81b5"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>

docs/examples.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Examples &mdash; CodeCarbon 3.1.0 documentation</title>
9+
<title>Examples &mdash; CodeCarbon 3.1.1 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=dd1205ac"></script>
16+
<script src="_static/documentation_options.js?v=796a81b5"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>

docs/faq.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Frequently Asked Questions &mdash; CodeCarbon 3.1.0 documentation</title>
9+
<title>Frequently Asked Questions &mdash; CodeCarbon 3.1.1 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1212

1313

1414
<script src="_static/jquery.js?v=5d32c60e"></script>
1515
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
16-
<script src="_static/documentation_options.js?v=dd1205ac"></script>
16+
<script src="_static/documentation_options.js?v=796a81b5"></script>
1717
<script src="_static/doctools.js?v=9bcbadda"></script>
1818
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1919
<script src="_static/js/theme.js"></script>

docs/genindex.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Index &mdash; CodeCarbon 3.1.0 documentation</title>
8+
<title>Index &mdash; CodeCarbon 3.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
1010
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
1111

1212

1313
<script src="_static/jquery.js?v=5d32c60e"></script>
1414
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15-
<script src="_static/documentation_options.js?v=dd1205ac"></script>
15+
<script src="_static/documentation_options.js?v=796a81b5"></script>
1616
<script src="_static/doctools.js?v=9bcbadda"></script>
1717
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1818
<script src="_static/js/theme.js"></script>

0 commit comments

Comments
 (0)