docs: fix generated doc about licenses

[2bndy5]

resolves #158

Also includes some changes following #145

Summary by CodeRabbit

• Chores
  • Updated recommended extensions to focus on Python development, linting, and type checking.
  • Disabled colored output from Cargo during documentation builds to improve log readability.

[coderabbitai]

Walkthrough

The .vscode/extensions.json file was updated to remove one extension and add three Python-related extensions. In noxfile.py, the environment variable CARGO_TERM_COLOR was set to "never" during the MkDocs build process to disable colored output from Cargo. No public interfaces were changed.

Changes

File(s)	Change Summary
.vscode/extensions.json	Removed one extension ("wolfmah-vscode.just-syntax"); added three Python-related extensions ("ms-python.python", "charliermarsh.ruff", "ms-python.mypy-type-checker").
noxfile.py	Set CARGO_TERM_COLOR environment variable to "never" in the run_mkdocs function's subprocess call.

Assessment against linked issues

Objective	Addressed	Explanation
Fix dependency name display issue (#158)	❌	No code changes address the display of dependency names or related functionality.

Assessment against linked issues: Out-of-scope changes

Code Change	Explanation
Update VSCode extension recommendations (.vscode/extensions.json)	This change is unrelated to the dependency name display issue described in the linked issue.
Set CARGO_TERM_COLOR in MkDocs build (noxfile.py)	This environment variable change does not relate to dependency name display functionality.

Possibly related PRs

• add gitlens to vscode and update repo link #90: Modifies the same VSCode extension recommendations file but in the opposite direction by adding "eamodio.gitlens", directly related to the extension management in this PR.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4d86d48 and 628ebbd.

📒 Files selected for processing (1)

• .vscode/extensions.json (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• .vscode/extensions.json

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: cargo-tools

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[2bndy5]

I forgot the recommended gitlense VSCode ext added in #90. Thanks to @coderabbitai summary for reminding me.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

@2bndy5, you're welcome! I'm glad the summary helped catch that. Let me check the current state of your extensions.json file to see what's currently there and confirm if the GitLens extension needs to be added back.

---

🏁 Script executed:

#!/bin/bash
# Check the current content of .vscode/extensions.json to see what extensions are recommended
cat .vscode/extensions.json

Length of output: 300

---

@2bndy5, actually looking at the current .vscode/extensions.json file, the GitLens extension (eamodio.gitlens) is already present in the recommendations! It looks like you may have already added it back, or it was preserved during your changes.

Let me check the actual diff to see what was changed in this PR to confirm.

---

🏁 Script executed:

#!/bin/bash
# Check the git diff for .vscode/extensions.json to see what was actually changed in this PR
git diff HEAD~1 .vscode/extensions.json

Length of output: 228

---

@2bndy5, let me check the git history and changes in a different way to understand what was actually modified in this PR.

---

🏁 Script executed:

#!/bin/bash
# Check the git log to see recent commits
git log --oneline -5

# Check the diff from the base branch
git diff origin/main .vscode/extensions.json

# Also check what files were modified in the last commit
git show --name-only HEAD

Length of output: 4966

---

@2bndy5, you're very welcome! 🎉

Looking at the git diff, I can see what happened here. The GitLens extension (eamodio.gitlens) was actually never removed from the .vscode/extensions.json file - it was preserved throughout your changes. You only removed the "wolfmah-vscode.just-syntax" extension and added the three Python-related ones.

Your latest commit shows "revert removal of gitlense recommended VSCode ext", but it appears the GitLens extension was there all along! The AI summary mentioning PR #90 (which originally added GitLens) probably made you think it had been accidentally removed, but it was actually safe the whole time.

So no harm done - your VSCode extensions are all set with both the new Python tools and the GitLens extension! 👍

---

🧠 Learnings used

Learnt from: 2bndy5
PR: cpp-linter/cpp-linter-rs#50
File: docs/badge_hook.py:57-62
Timestamp: 2024-09-29T18:07:57.384Z
Learning: In `docs/badge_hook.py`, only older versions of the `cpp-linter` project are handled, so adding a dependency for version comparison is unnecessary.

[2bndy5]

By visually inspecting this PR's RTD build, you'll see that #158 is indeed resolved. It was a problem with asci escape codes.