Skip to content

docs(datasets): fix optuna StudyDataset documentation page#1372

Merged
deepyaman merged 6 commits intokedro-org:mainfrom
gtauzin:docs/fix-optuna-studydataset-doc-page
Apr 28, 2026
Merged

docs(datasets): fix optuna StudyDataset documentation page#1372
deepyaman merged 6 commits intokedro-org:mainfrom
gtauzin:docs/fix-optuna-studydataset-doc-page

Conversation

@gtauzin
Copy link
Copy Markdown
Contributor

@gtauzin gtauzin commented Apr 4, 2026

Description

Ensure the optuna.StudyDataset docs renders properly.

Development notes

  • Convert RST code-block directives to fenced Markdown code blocks
  • Convert RST link syntax to Markdown link syntax
  • Add try/except import in init.py for doc builds without optuna
  • Add standard title and description to the doc page
  • Built and served the docs to ensure everything renders properly

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Updated jsonschema/kedro-catalog-X.XX.json if necessary
  • Added a description of this change in the relevant RELEASE.md file
  • Added tests to cover my changes
  • Received approvals from at least half of the TSC (required for adding a new, non-experimental dataset)

gtauzin added 2 commits April 4, 2026 14:45
Convert StudyDataset class docstring from reStructuredText to Markdown
to comply with the project's markdown-parseable docstring requirement.

Changes:
- Convert RST code-block directives to fenced Markdown code blocks
- Convert RST link syntax to Markdown link syntax
- Add try/except import in __init__.py for doc builds without optuna
- Add standard title and description to the doc page

Signed-off-by: Guillaume Tauzin <4648633+gtauzin@users.noreply.github.com>
Signed-off-by: Guillaume Tauzin <4648633+gtauzin@users.noreply.github.com>
Copy link
Copy Markdown
Member

@deepyaman deepyaman 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, just a couple minor changes to the release notes.

Comment thread kedro-datasets/RELEASE.md Outdated
Comment thread kedro-datasets/RELEASE.md Outdated
gtauzin and others added 2 commits April 7, 2026 08:40
Co-authored-by: Deepyaman Datta <deepyaman.datta@utexas.edu>
Signed-off-by: Guillaume Tauzin <4648633+gtauzin@users.noreply.github.com>
Co-authored-by: Deepyaman Datta <deepyaman.datta@utexas.edu>
Signed-off-by: Guillaume Tauzin <4648633+gtauzin@users.noreply.github.com>
@gtauzin
Copy link
Copy Markdown
Contributor Author

gtauzin commented Apr 7, 2026

@deepyaman Thanks a lot for the quick review, all done! :)

Signed-off-by: Deepyaman Datta <deepyaman.datta@utexas.edu>
@deepyaman deepyaman enabled auto-merge (squash) April 7, 2026 13:16
@deepyaman deepyaman self-requested a review April 7, 2026 13:16
Copy link
Copy Markdown
Member

@merelcht merelcht left a comment

Choose a reason for hiding this comment

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

Thanks @gtauzin !

Signed-off-by: Merel Theisen <49397448+merelcht@users.noreply.github.com>
@deepyaman deepyaman merged commit 3a0562d into kedro-org:main Apr 28, 2026
24 of 26 checks passed
@gtauzin gtauzin deleted the docs/fix-optuna-studydataset-doc-page branch April 28, 2026 14:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants