Skip to content

Adding documentation using RTD and Sphinx#47

Draft
surbhigoel77 wants to merge 71 commits intomainfrom
readme2
Draft

Adding documentation using RTD and Sphinx#47
surbhigoel77 wants to merge 71 commits intomainfrom
readme2

Conversation

@surbhigoel77
Copy link
Collaborator

@surbhigoel77 surbhigoel77 commented Jun 26, 2025

Fixes #49 #51

At present, we are able to build RTD for existing README.md locally (trying to build in on the RTD platform to make it live). Once the documentation pipeline is functioning, we can add new docs and pages.

Suggested content:

  1. Why Spinup-Evaluation
  2. Installation
  3. Evaluation Quickstart
  4. Benchmarking dataset guide
  5. Command line scripts
  6. Evaluation Metrics (Deterministic, Probabilistic, Physical-Metrics)

For Automation:

  • .readthedocs.yml will automatically triggers a build upon a new commit.

@surbhigoel77 surbhigoel77 marked this pull request as draft June 27, 2025 11:01
@ma595 ma595 added the documentation Improvements or additions to documentation label Jul 16, 2025
@ma595
Copy link
Member

ma595 commented Jul 16, 2025

@surbhigoel77 what's the current status of this PR?

@surbhigoel77 surbhigoel77 changed the title Updated Intro and renamed and updated Usage section to Function Adding documentation using RTD and Sphinx Jul 24, 2025
@surbhigoel77 surbhigoel77 linked an issue Jul 24, 2025 that may be closed by this pull request
@ma595
Copy link
Member

ma595 commented Jan 23, 2026

Hi @SimonSadler I think this is the PR that Surbhi opened for the RTD work. I think it need a little tidy up before merging. Let's discuss this over Slack or in the internal meeting at some point.

@ma595 ma595 self-assigned this Mar 9, 2026
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation using Sphinx and Readthedocs (RTD) [META] Documentation

2 participants