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.

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

Implement RTD support #600

Merged
merged 16 commits into from
Dec 10, 2024
Merged

Implement RTD support #600

merged 16 commits into from
Dec 10, 2024

Conversation

MicahGale
Copy link
Collaborator

@MicahGale MicahGale commented Dec 3, 2024

Pull Request Checklist for MontePy

Description

This sets up the configuration for RTD, and tweaks the theme to work better with RTD. This:

  • Adds support for ethical ads
  • Adds "MontePy" to navbar
  • Switches to / to support multi-version
    • will set an RTD redirect for migration plan to keep deprecation warnings valid
  • Added meta descriptions to most top level pages.
  • Added support for Epub and PDF

Fixes #593, Fixes #594


Post Merge Checklist

  • configure idaholab/montepy on RTD
  • setup webhooks/ GHA to test build
  • verify links and sitemaps
  • Switch to stable as default.
  • Migrate domain to RTD
  • Remove github pages from metadata

General Checklist

  • I have performed a self-review of my own code.
  • The code follows the standards outlined in the development documentation.
  • I have added tests that prove my fix is effective or that my feature works (if applicable).
  • I have made corresponding changes to the documentation, providing clear details on the added or modified functionality (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 tests pass locally before CI checks.
  • The PR covers all relevant aspects according to the development guidelines.
    """

@MicahGale MicahGale self-assigned this Dec 3, 2024
@MicahGale MicahGale added the documentation Improvements or additions to documentation label Dec 3, 2024
@MicahGale
Copy link
Collaborator Author

Sitemaps are no longer needed. RTD handles that: https://docs.readthedocs.io/en/stable/reference/sitemaps.html

@MicahGale MicahGale requested a review from tjlaboss December 3, 2024 14:50
@MicahGale MicahGale marked this pull request as ready for review December 3, 2024 14:50
@MicahGale
Copy link
Collaborator Author

@MicahGale MicahGale added the CI/CD label Dec 9, 2024
@MicahGale MicahGale merged commit e6c0e86 into idaholab:develop Dec 10, 2024
23 checks passed
@MicahGale
Copy link
Collaborator Author

@MicahGale MicahGale mentioned this pull request Dec 12, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve branding in website. Migrate to read the docs
2 participants