Adjust project files after migration to MkDocs #2381

KJhellico · 2025-03-27T16:34:19Z

Proposed change

Adjust various project files after migration to MkDocs.

Type of change

New country/market holidays support (thank you!)
Supported country/market holidays update (calendar discrepancy fix, localization)
Existing code/documentation/test/process quality improvement (best practice, cleanup, refactoring, optimization)
Dependency update (version deprecation/pin/upgrade)
Bugfix (non-breaking change which fixes an issue)
Breaking change (a code change causing existing functionality to break)
New feature (new holidays functionality in general)

Checklist

I've followed the contributing guidelines
I've successfully run make check, all checks and tests are green

coderabbitai · 2025-03-27T16:34:29Z

Summary by CodeRabbit

Documentation
- Updated contributing guidelines link and supported translations reference to use Markdown documentation.
- Transitioned the documentation build process to a new tool for generating updated docs.
Chores
- Streamlined cleanup procedures by removing redundant commands in build and test configurations.

Walkthrough

This pull request updates documentation reference links and adjusts the documentation build and cleanup commands. The PR template now links to the Markdown version of the contributing guidelines, and the contributing file itself has been modified to refer to a Markdown README. In addition, the Makefile and make.cmd files no longer clean up documentation build directories, and the build process has been changed from Sphinx to MkDocs. The tox.ini file has also been updated accordingly.

Changes

Files	Change Summary
`.github/PULL_REQUEST_TEMPLATE.md`, `CONTRIBUTING.md`	Updated reference links from using `.rst` files to their Markdown (`.md`) counterparts.
`Makefile`, `make.cmd`, `tox.ini`	Removed cleanup commands for documentation directories and switched the documentation build commands from Sphinx (`sphinx-build`) to MkDocs (`mkdocs`).

Suggested labels

script

Suggested reviewers

PPsyrius

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d0eaf75 and 0736a52.

📒 Files selected for processing (5)

.github/PULL_REQUEST_TEMPLATE.md (1 hunks)
CONTRIBUTING.md (1 hunks)
Makefile (0 hunks)
make.cmd (1 hunks)
tox.ini (1 hunks)

💤 Files with no reviewable changes (1)

Makefile

⏰ Context from checks skipped due to timeout of 300000ms (1)

GitHub Check: Test build on windows-latest

🔇 Additional comments (4)

.github/PULL_REQUEST_TEMPLATE.md (1)

43-43: Link reference properly updated to Markdown format.

The link to contributing guidelines now correctly points to the Markdown version of the file instead of the RST version, maintaining consistency with the migration to MkDocs.

tox.ini (1)

27-27: External command correctly updated for MkDocs.

The allowlist_externals section now properly includes mkdocs instead of sphinx-build, aligning with the project's documentation tool migration.

CONTRIBUTING.md (1)

83-83: README reference correctly updated to Markdown format.

The instruction now properly directs contributors to update translations in README.md rather than README.rst, maintaining consistency with the documentation format migration.

make.cmd (1)

33-33: Documentation build command updated to use MkDocs.

The build command has been correctly changed to use MkDocs instead of Sphinx. The removal of Sphinx-specific directory cleanup commands is also appropriate as these directories are no longer relevant with MkDocs.

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

🪧 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.
- Generate unit testing code for this file.
- 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 generate unit testing code for this file.
- @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 generate unit testing code.
- @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.

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 resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@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.

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.

sonarqubecloud · 2025-03-27T16:35:14Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

codecov · 2025-03-27T16:36:06Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d0eaf75) to head (0736a52).
Report is 1 commits behind head on dev.

Additional details and impacted files

@@            Coverage Diff            @@
##               dev     #2381   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          204       204           
  Lines        12853     12853           
  Branches      1817      1817           
=========================================
  Hits         12853     12853

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

PPsyrius

LGTM 🛠️

arkid15r

LGTM

Adjust project files after migration to MkDocs

0736a52

KJhellico requested review from arkid15r and PPsyrius as code owners March 27, 2025 16:34

PPsyrius approved these changes Mar 27, 2025

View reviewed changes

arkid15r reviewed Mar 27, 2025

View reviewed changes

arkid15r added this pull request to the merge queue Mar 27, 2025

Merged via the queue into vacanza:dev with commit d06b665 Mar 27, 2025
33 checks passed

KJhellico deleted the upd-mkdocs-adjust branch March 27, 2025 17:40

arkid15r mentioned this pull request Apr 7, 2025

v0.70 #2443

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Adjust project files after migration to MkDocs #2381

Adjust project files after migration to MkDocs #2381

Uh oh!

KJhellico commented Mar 27, 2025

Uh oh!

coderabbitai bot commented Mar 27, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

sonarqubecloud bot commented Mar 27, 2025

Uh oh!

codecov bot commented Mar 27, 2025 •

edited

Loading

Uh oh!

PPsyrius left a comment

Uh oh!

arkid15r left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Adjust project files after migration to MkDocs #2381

Adjust project files after migration to MkDocs #2381

Uh oh!

Conversation

KJhellico commented Mar 27, 2025

Proposed change

Type of change

Checklist

Uh oh!

coderabbitai bot commented Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Walkthrough

Changes

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

sonarqubecloud bot commented Mar 27, 2025

Quality Gate passed

Uh oh!

codecov bot commented Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

PPsyrius left a comment

Choose a reason for hiding this comment

Uh oh!

arkid15r left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot commented Mar 27, 2025 •

edited

Loading

codecov bot commented Mar 27, 2025 •

edited

Loading