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

docs: Add reference in training getting started guide for intersphinx #220

Merged
merged 1 commit into from
Mar 28, 2025

Conversation

aaron-hopkinson
Copy link
Contributor

@aaron-hopkinson aaron-hopkinson commented Mar 27, 2025

Add reference in training "getting started guide" to support intersphinx linking from "main" docs pages.

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Issue Number

Code Compatibility

  • I have performed a self-review of my code

Code Performance and Testing

  • I have added tests that prove my fix is effective or that my feature works
  • I ran the complete Pytest test suite locally, and they pass
  • I have tested the changes on a single GPU
  • I have tested the changes on multiple GPUs / multi-node setups
  • I have run the Benchmark Profiler against the old version of the code
  • If the new feature introduces modifications at the config level, I have made sure to update Pydantic Schemas and default configs accordingly

Dependencies

  • I have ensured that the code is still pip-installable after the changes and runs
  • I have tested that new dependencies themselves are pip-installable.
  • I have not introduced new dependencies in the inference portion of the pipeline

Documentation

  • My code follows the style guidelines of this project
  • I have updated the documentation and docstrings to reflect the changes
  • I have added comments to my code, particularly in hard-to-understand areas

Additional Notes


📚 Documentation preview 📚: https://anemoi-training--220.org.readthedocs.build/en/220/


📚 Documentation preview 📚: https://anemoi-graphs--220.org.readthedocs.build/en/220/


📚 Documentation preview 📚: https://anemoi-models--220.org.readthedocs.build/en/220/

@FussyDuck
Copy link

FussyDuck commented Mar 27, 2025

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added training documentation Improvements or additions to documentation labels Mar 27, 2025
@aaron-hopkinson aaron-hopkinson merged commit f1d5e1f into main Mar 28, 2025
30 checks passed
@aaron-hopkinson aaron-hopkinson deleted the docs/training_getting_started_intersphinx_ref branch March 28, 2025 09:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation training
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants