Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated canonical URL for RTD multi-version. #672

Merged
merged 1 commit into from
Feb 28, 2025
Merged

Updated canonical URL for RTD multi-version. #672

merged 1 commit into from
Feb 28, 2025

Conversation

MicahGale
Copy link
Collaborator

@MicahGale MicahGale commented Feb 28, 2025 •
edited by github-actions bot
Loading

Pull Request Checklist for MontePy

Description

This updates a shpinx setting to update the canonical URL to be valid. Canonical URLs is how Search engines decide which page to show when multiple versions exist. Right now this looks like:

<html lang="en" data-content_root="./" >
  <head>
...
    <link rel="canonical" href="https://www.montepy.org/starting.html" />
...

The update building on RTD now looks like:

<html lang="en" data-content_root="./" >
  <head>
...
    <link rel="canonical" href="https://www.montepy.org/en/stable/starting.html" />
...

Related to: openmc-dev/openmc#3324

General Checklist

  • I have performed a self-review of my own code.
  • The code follows the standards outlined in the development documentation.
  • I have formatted my code with black version 25.
  • I have added tests that prove my fix is effective or that my feature works (if applicable).

Documentation Checklist
  • I have documented all added classes and methods.
  • For infrastructure updates, I have updated the developer's guide.
  • For significant new features, I have added a section to the getting started guide.

First-Time Contributor Checklist
  • If this is your first contribution, add yourself to pyproject.toml if you wish to do so.

Additional Notes for Reviewers

Ensure that:

  • The submitted code is consistent with the merge checklist outlined here.
  • The PR covers all relevant aspects according to the development guidelines.
  • 100% coverage of the patch is achieved, or justification for a variance is given.

📚 Documentation preview 📚: https://montepy--672.org.readthedocs.build/en/672/

@MicahGale MicahGale self-assigned this Feb 28, 2025
@MicahGale MicahGale added the documentation Improvements or additions to documentation label Feb 28, 2025
@MicahGale MicahGale marked this pull request as ready for review February 28, 2025 22:24
@MicahGale MicahGale requested a review from tjlaboss February 28, 2025 22:24
@MicahGale MicahGale mentioned this pull request Feb 28, 2025
Merged
@MicahGale MicahGale merged commit 2f9e0c8 into develop Feb 28, 2025
28 checks passed
@MicahGale MicahGale deleted the rtd_canonical branch February 28, 2025 22:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tjlaboss tjlaboss Awaiting requested review from tjlaboss

Assignees

@MicahGale MicahGale

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@MicahGale