Skip to content

Adding documentation using RTD and Sphinx #47

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
Draft
surbhigoel77 wants to merge 71 commits into
base: main
Choose a base branch
from
Draft

Adding documentation using RTD and Sphinx #47

surbhigoel77 wants to merge 71 commits into from

Conversation

@surbhigoel77
Copy link
Collaborator

@surbhigoel77 surbhigoel77 commented Jun 26, 2025 •
edited
Loading

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
Documentation using Sphinx and Readthedocs (RTD) #51
Open
@surbhigoel77
Update headings of modules
ac6b3a0
@surbhigoel77
Update README location
3eaaf4c
@surbhigoel77
Update file name for CLI md
41b19f6
@surbhigoel77
Update README as Home
b9a1a05
@surbhigoel77
Remove redundant spinup_eval and README
adefff8
@surbhigoel77
Added seperate page for eval modes
9e6257a
@surbhigoel77
Add Eval Modes md to index.rst
5fc6312
@surbhigoel77
Remove numebering from modes in eval modes md
abeb931
@surbhigoel77
Add Model confi file to documentation
22d00ad
@surbhigoel77
Add Model config to index.rst
d8f82e4
@surbhigoel77
Corrected the name of the model config file in index.rst
000dad7
@surbhigoel77
Add heading to the file
a6cbbd1
@surbhigoel77
Add evaluation flow diagram
b862e62
@surbhigoel77
Add evaluation process in documentation as Evaluation.md
25a69b9
@surbhigoel77
Updated the sequence of pages for RTD
82c6bfc
@surbhigoel77
Remove intro line from md files
c7f3f16
@surbhigoel77
Remove sections and create new RTD pages
f50ad90
@surbhigoel77
Hide contents from home, keep only in sidebar
02469c5
@surbhigoel77
Comment out section in README
17421f7
@surbhigoel77
Add new metrics md to RTD
06052fc
@surbhigoel77
Add new metrics to index.rst
66ad3b0
@surbhigoel77
Comment out sections from README to make seperate RTD pages
4b57ddc
@surbhigoel77
Comment out link to RTD
ef3fbf2
@surbhigoel77
Renamed Home page as Homepage
9f64848
@surbhigoel77
Added new folder _static to keep diagrams
63f5dad
@surbhigoel77
Updated path to diagram.png
0f2b398
@surbhigoel77
Create placeholder for walkthrough example of toolbox use
37a8061
@surbhigoel77
Add Example md to index.rst
6a78326
@surbhigoel77
Added new subsection for OM4 config
0191cd6
@surbhigoel77
Added new subsection for ORCA2 config
45e6250
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@surbhigoel77 surbhigoel77

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

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

3 participants

@surbhigoel77 @ma595