Skip to content

Commit d858c68

Browse files
benoit-ctybenoit-cty
andauthored
Add /latest/ to all links (#1153)
Co-authored-by: benoit-cty <anne@onyme.fr>
1 parent a32b03d commit d858c68

9 files changed

Lines changed: 26 additions & 26 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ What types of changes does your code introduce? Put an `x` in all the boxes that
2020

2121
## AI Usage Disclosure
2222

23-
Please refer to [docs/how-to/ai-policy.md](https://docs.codecarbon.io/how-to/ai_policy/) for detailed guidelines on how to disclose AI usage in your PR. Accurately completing this section is mandatory.
23+
Please refer to [docs/how-to/ai-policy.md](https://docs.codecarbon.io/latest/how-to/ai_policy/) for detailed guidelines on how to disclose AI usage in your PR. Accurately completing this section is mandatory.
2424

2525
- [ ] 🟥 AI-vibecoded: You cannot explain the logic. Car analogy : the car drive by itself, you are outside it and just tell it where to go.
2626
- [ ] 🟠 AI-generated: Car analogy : the car drive by itself, you are inside and give instructions.
@@ -32,7 +32,7 @@ Go over all the following points, and put an `x` in all the boxes that apply.
3232
- [ ] My code follows the code style of this project.
3333
- [ ] My change requires a change to the documentation.
3434
- [ ] I have updated the documentation accordingly.
35-
- [ ] I have read the **[docs/how-to/contributing.md](https://docs.codecarbon.io/how-to/contributing/)** document.
35+
- [ ] I have read the **[docs/how-to/contributing.md](https://docs.codecarbon.io/latest/how-to/contributing/)** document.
3636
- [ ] I have added tests to cover my changes.
3737
- [ ] All new and existing tests passed.
3838

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ conda activate your_env
2525
pip install codecarbon
2626
```
2727

28-
More installation options: [installation docs](https://docs.codecarbon.io/how-to/installation/).
28+
More installation options: [installation docs](https://docs.codecarbon.io/latest/how-to/installation/).
2929

3030
## Quickstart (Python)
3131

@@ -41,7 +41,7 @@ emissions = tracker.stop()
4141
print(f"Emissions: {emissions} kg CO₂")
4242
```
4343

44-
[**Learn more**](https://docs.codecarbon.io/tutorials/first-tracking/)
44+
[**Learn more**](https://docs.codecarbon.io/latest/tutorials/first-tracking/)
4545

4646
## Quickstart (CLI)
4747

@@ -57,7 +57,7 @@ Detect your hardware:
5757
codecarbon detect
5858
```
5959

60-
Full CLI guide: [CLI tutorial](https://docs.codecarbon.io/tutorials/cli/).
60+
Full CLI guide: [CLI tutorial](https://docs.codecarbon.io/latest/tutorials/cli/).
6161

6262
## Configuration
6363

@@ -68,34 +68,34 @@ You can configure CodeCarbon using:
6868
- `CODECARBON_*` environment variables
6969
- Python arguments (`EmissionsTracker(...)`)
7070

71-
Configuration precedence and examples: [configuration guide](https://docs.codecarbon.io/how-to/configuration/).
71+
Configuration precedence and examples: [configuration guide](https://docs.codecarbon.io/latest/how-to/configuration/).
7272

7373
## How it works
7474

7575
We created a Python package that estimates your hardware electricity power consumption (GPU + CPU + RAM) and we apply to it the carbon intensity of the region where the computing is done.
7676

7777
![calculation Summary](docs/images/calculation.png)
7878

79-
We explain more about this calculation in the [**Methodology**](https://docs.codecarbon.io/explanation/methodology/) section of the documentation.
79+
We explain more about this calculation in the [**Methodology**](https://docs.codecarbon.io/latest/explanation/methodology/) section of the documentation.
8080

8181
## Visualize
8282

83-
You can visualize your experiment emissions on the [dashboard](https://dashboard.codecarbon.io/) or locally with [carbonboard](https://docs.codecarbon.io/how-to/visualize/).
83+
You can visualize your experiment emissions on the [dashboard](https://dashboard.codecarbon.io/) or locally with [carbonboard](https://docs.codecarbon.io/latest/how-to/visualize/).
8484

8585
![dashboard](docs/images/dashboard.png)
8686

8787
## Quick links
8888

8989
| Section | Description |
9090
|---------|-------------|
91-
| [Quickstart](https://docs.codecarbon.io/tutorials/first-tracking/) | Get started in 5 minutes |
92-
| [Installation](https://docs.codecarbon.io/how-to/installation/) | Install CodeCarbon |
93-
| [CLI Tutorial](https://docs.codecarbon.io/tutorials/cli/) | Track emissions from the command line |
94-
| [Python API Tutorial](https://docs.codecarbon.io/tutorials/python-api/) | Track emissions in Python code |
95-
| [Comparing Model Efficiency](https://docs.codecarbon.io/tutorials/comparing-model-efficiency/) | Measure carbon efficiency across ML models |
96-
| [API Reference](https://docs.codecarbon.io/reference/api/) | Full parameter documentation |
97-
| [Framework examples (scikit-learn)](https://docs.codecarbon.io/how-to/scikit-learn/) | Task-oriented ML framework examples |
98-
| [Methodology](https://docs.codecarbon.io/explanation/methodology/) | How emissions are calculated |
91+
| [Quickstart](https://docs.codecarbon.io/latest/tutorials/first-tracking/) | Get started in 5 minutes |
92+
| [Installation](https://docs.codecarbon.io/latest/how-to/installation/) | Install CodeCarbon |
93+
| [CLI Tutorial](https://docs.codecarbon.io/latest/tutorials/cli/) | Track emissions from the command line |
94+
| [Python API Tutorial](https://docs.codecarbon.io/latest/tutorials/python-api/) | Track emissions in Python code |
95+
| [Comparing Model Efficiency](https://docs.codecarbon.io/latest/tutorials/comparing-model-efficiency/) | Measure carbon efficiency across ML models |
96+
| [API Reference](https://docs.codecarbon.io/latest/reference/api/) | Full parameter documentation |
97+
| [Framework examples (scikit-learn)](https://docs.codecarbon.io/latest/how-to/scikit-learn/) | Task-oriented ML framework examples |
98+
| [Methodology](https://docs.codecarbon.io/latest/explanation/methodology/) | How emissions are calculated |
9999
| [EcoLogits](https://ecologits.ai/) | Track emissions from GenAI API calls |
100100

101101
## Links

codecarbon/cli/main.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ def config():
310310
overwrite_local_config("api_key", api_key, path=file_path)
311311
show_config(file_path)
312312
print(
313-
"Consult [link=https://docs.codecarbon.io/how-to/configuration/]configuration documentation[/link] for more configuration options"
313+
"Consult [link=https://docs.codecarbon.io/latest/how-to/configuration/]configuration documentation[/link] for more configuration options"
314314
)
315315

316316

codecarbon/core/powermetrics.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def _has_powermetrics_sudo() -> bool:
5858
"""Not using PowerMetrics, sudo password prompt detected.
5959
If you want to enable Powermetrics please modify your sudoers file
6060
as described in :
61-
https://docs.codecarbon.io/explanation/methodology/#power-usage
61+
https://docs.codecarbon.io/latest/explanation/methodology/#power-usage
6262
"""
6363
)
6464
return False

codecarbon/external/ram.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class RAM(BaseHardware):
2424
In V3, we need to improve the accuracy of the RAM power estimation.
2525
Because the power consumption of RAM is not linear with the amount of memory used,
2626
27-
See https://docs.codecarbon.io/explanation/methodology/#ram for details on the RAM
27+
See https://docs.codecarbon.io/latest/explanation/methodology/#ram for details on the RAM
2828
power estimation methodology.
2929
3030
"""

docs/how-to/agent-instructions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ uv run task -l
152152
## Documentation and Help
153153

154154
### Key Documentation Files
155-
- **[CONTRIBUTING.md](https://docs.codecarbon.io/how-to/contributing/)**: Detailed contribution guidelines and setup
155+
- **[CONTRIBUTING.md](https://docs.codecarbon.io/latest/how-to/contributing/)**: Detailed contribution guidelines and setup
156156
- **[README.md](https://github.com/mlco2/codecarbon/blob/master/README.md)**: Project overview and quickstart
157157
- **[carbonserver/README.md](https://github.com/mlco2/codecarbon/blob/master/carbonserver/README.md)**: API architecture and database schema
158158
- **[webapp/README.md](https://github.com/mlco2/codecarbon/blob/master/webapp/README.md)**: Next.js dashboard setup
@@ -165,7 +165,7 @@ The repository includes VS Code launch configurations in `docs/how-to/contributi
165165
- Testing codecarbon CLI monitor
166166

167167
### Getting Help
168-
- **[FAQ](https://docs.codecarbon.io/explanation/faq/)**
168+
- **[FAQ](https://docs.codecarbon.io/latest/explanation/faq/)**
169169
- **[Documentation](https://docs.codecarbon.io)**
170170
- **[Issues](https://github.com/mlco2/codecarbon/issues)**
171171

docs/how-to/ai_policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ AI models often hallucinate comments or reinvent existing utilities.
7272

7373
If you are an AI agent (GitHub Copilot, CodeRabbit, etc.) reviewing a PR for CodeCarbon, you must follow the repository's dedicated reviewer instructions.
7474

75-
The **canonical and up-to-date instructions for AI reviewers** are maintained in [`.github/copilot-instructions.md`](https://docs.codecarbon.io/how-to/agent-instructions/). That document defines:
75+
The **canonical and up-to-date instructions for AI reviewers** are maintained in [`.github/copilot-instructions.md`](https://docs.codecarbon.io/latest/how-to/agent-instructions/). That document defines:
7676

7777
- The expected reviewer persona and responsibilities
7878
- The checks to perform on PR descriptions, code, tests, and comments

docs/how-to/contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
<!-- TOC --><a name="have-a-question"></a>
4040
## </a> Have a Question?
4141

42-
Please see the [FAQ](https://docs.codecarbon.io/explanation/faq/) for questions.
42+
Please see the [FAQ](https://docs.codecarbon.io/latest/explanation/faq/) for questions.
4343

4444

4545
<!-- TOC --><a name="found-a-bug"></a>
@@ -148,7 +148,7 @@ To test CodeCarbon, it is useful to stress your computer to make it use its full
148148

149149
- 7Zip is often already installed, running it with `7z b` makes a quick CPU test.
150150
- [GPU-burn](https://github.com/wilicc/gpu-burn) will load test the GPU for a configurable duration.
151-
- To test the CPU : `stress-ng --cpu 0 --cpu-method matrixprod --metrics-brief --rapl --perf -t 60s` See [our documentation](https://docs.codecarbon.io/how-to/test-on-scaleway/) to install it.
151+
- To test the CPU : `stress-ng --cpu 0 --cpu-method matrixprod --metrics-brief --rapl --perf -t 60s` See [our documentation](https://docs.codecarbon.io/latest/how-to/test-on-scaleway/) to install it.
152152
- To do useful computation while testing [Folding At Home](https://foldingathome.org/) is a good option.
153153
- [OCCT](https://www.ocbase.com/download) is a proprietary tool but free for non-commercial use and available for Windows and Linux.
154154

webapp/src/app/(dashboard)/home/page.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,10 @@ export default function HomePage() {
7878
For more information, please refer to the documentation:
7979
<br />
8080
<a
81-
href="https://docs.codecarbon.io/tutorials/cli/"
81+
href="https://docs.codecarbon.io/latest/tutorials/cli/"
8282
target="_blank"
8383
>
84-
https://docs.codecarbon.io/tutorials/cli/
84+
https://docs.codecarbon.io/latest/tutorials/cli/
8585
</a>
8686
</CardDescription>
8787
</CardHeader>

0 commit comments

Comments
 (0)