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(graphs): update graph docs to template (docathon) #219

Merged
merged 8 commits into from
Mar 27, 2025

Conversation

VeraChristina
Copy link
Collaborator

@VeraChristina VeraChristina commented Mar 26, 2025

Description

  • Update the graph documentation to the anemoi template following the docathon meta discussion.
  • Replace the contributing guidelines with reference to main contributing guidelines.
  • Fix link to installing section in anemoi training docs to point to installing section in graphs instead.

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

@VeraChristina
Copy link
Collaborator Author

@b8raoult Would you add the logo with subtitle for graphs?

@VeraChristina VeraChristina marked this pull request as ready for review March 26, 2025 15:20
@VeraChristina VeraChristina requested a review from JPXKQX March 26, 2025 15:21
Copy link
Contributor

@aaron-hopkinson aaron-hopkinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking this on. Looks good to me (aside from one minor concern re: "command line usage" vs "tool")

Another minor suggestion, could you fix the broken link on L15-16 of index.rst so that it points to the index of the main docs page with intersphinx, please?

I think this should be:

of the packages within the :ref:`anemoi framework <anemoi-docs:index>`.

(Can't do an inline suggestion because it's too far away from a change...)

Copy link
Contributor

@aaron-hopkinson aaron-hopkinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - thank you!

@VeraChristina VeraChristina merged commit ae4f1c5 into main Mar 27, 2025
30 checks passed
@VeraChristina VeraChristina deleted the docs/update-graph-docs-to-template branch March 27, 2025 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants