Skip to content

ci: add github workflow to autogenerate sphinx dataset pages #1147

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

Open
wants to merge 47 commits into
base: main
Choose a base branch
from

Conversation

dkrako
Copy link
Contributor

@dkrako dkrako commented May 10, 2025

Description

This PR autogenerates sphinx datasets pages without requiring any dataset definition classes.

For now the datasets pages are very rudimentary, listing only the name of the dataset and a link to the dataset definition class.

Implemented changes

  • create table of contents for datasets
  • create templates for dataset pages
  • write script to create rst files for each dataset
  • extend script to create a metadata file for each dataset

How Has This Been Tested?

  • test that rst files are created
  • test that metadata files are created

Context

related issues:

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

Copy link

codecov bot commented May 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (569a4df) to head (178a455).

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1147   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           93        94    +1     
  Lines         4042      4062   +20     
  Branches       715       716    +1     
=========================================
+ Hits          4042      4062   +20     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dkrako dkrako force-pushed the ci/write-dataset-rst branch from eb7062c to 429c446 Compare May 11, 2025 21:30
@dkrako dkrako marked this pull request as ready for review May 26, 2025 10:36
@dkrako dkrako requested review from SiQube and prassepaul as code owners May 26, 2025 10:36
@dkrako dkrako enabled auto-merge (squash) May 26, 2025 10:37
Copy link
Member

@SiQube SiQube left a comment

Choose a reason for hiding this comment

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

@dkrako dkrako closed this May 27, 2025
auto-merge was automatically disabled May 27, 2025 15:07

Pull request was closed

@dkrako dkrako reopened this May 27, 2025
@dkrako dkrako enabled auto-merge (squash) May 27, 2025 15:08
@dkrako dkrako disabled auto-merge May 28, 2025 04:10
@dkrako dkrako enabled auto-merge (squash) May 28, 2025 04:10
@dkrako dkrako disabled auto-merge May 28, 2025 04:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants