make copyright year dynamic

[jcharkow]

User description

this allows the datetime of the copyright to update with the current datetime

---

PR Type

enhancement, documentation

---

Description

• Enhanced the Sphinx configuration file to dynamically update the copyright year using the current year.
• This change ensures that the documentation always reflects the current year without manual updates.

---

Changes walkthrough 📝

	Relevant files
Enhancement	conf.py Make copyright year dynamic in Sphinx configuration            docs/source/conf.py Imported the datetime module. Updated the copyright year to be dynamic using datetime.now().year. +2/-1

---

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[qodo-code-review[bot]]

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

[qodo-code-review[bot]]

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Code Suggestions ✨

Category	Suggestion	Score
Best practice	Use explicit import for datetime to improve code clarity Use datetime.datetime.now() instead of datetime.now() to make the import and usage more explicit. docs/source/conf.py [26-78] -import datetime +from datetime import datetime ... copyright = f'{datetime.now().year}, OpenMS Team' Suggestion importance[1-10]: 8 Why: The suggestion to use from datetime import datetime makes the code more explicit and improves readability by clearly indicating which part of the module is being used.	8
Enhancement	Use UTC time to ensure consistency across time zones Consider using a UTC timestamp to ensure consistency across different time zones. docs/source/conf.py [78] -copyright = f'{datetime.now().year}, OpenMS Team' +copyright = f'{datetime.datetime.utcnow().year}, OpenMS Team' [ ] Apply this suggestion Suggestion importance[1-10]: 7 Why: Using UTC time can be beneficial for consistency across different environments, especially in distributed systems, although it might not be crucial for this specific use case.	7

💡 Need additional feedback ? start a PR chat

[coderabbitai[bot]]

Walkthrough

The change introduces a dynamic mechanism for setting the copyright year in the Sphinx documentation configuration. By importing the datetime module and referencing the current year at runtime, the copyright string will automatically update each year.

Changes

Cohort / File(s)	Change Summary
Dynamic Copyright Update docs/source/conf.py	Imported datetime and updated the copyright string to use the current year dynamically.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

In the warren of docs, a clever tweak, Now the copyright updates each week! No more years to change by hand, The datetime module lends a hand. Hopping forward, time’s our friend— Our documentation will never end! 🐇✨

[!NOTE]

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 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 2332706aa5d4f6fc0836aa4ea5cd6719235d011c and 1afbfbc5415f59530c1981793354c16683920297.

📒 Files selected for processing (1)

• docs/source/conf.py (2 hunks)

🧰 Additional context used

🪛 Ruff (0.12.2)

docs/source/conf.py

26-26: datetime imported but unused

Remove unused import: datetime

(F401)

🔇 Additional comments (2)

docs/source/conf.py (2)

26-26: LGTM! The datetime import is correctly used.

The static analysis tool incorrectly flags this as unused, but the datetime module is properly utilized in line 82 for dynamic copyright year generation.

---

82-82: Excellent implementation of dynamic copyright year!

The f-string approach cleanly integrates the current year into the copyright string, ensuring the documentation will always reflect the correct year without manual intervention.

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

🧪 Generate unit tests

• [ ] Create PR with unit tests
• [ ] Post copyable unit tests in a comment

---

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.
• 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.

Support

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

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 generate unit tests to generate unit tests for 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.