chore: fix docs build by SemyonSinchenko · Pull Request #821 · graphframes/graphframes · GitHub
Skip to content

chore: fix docs build#821

Merged
SemyonSinchenko merged 4 commits intographframes:mainfrom
SemyonSinchenko:fix-docs-build
Apr 1, 2026
Merged

chore: fix docs build#821
SemyonSinchenko merged 4 commits intographframes:mainfrom
SemyonSinchenko:fix-docs-build

Conversation

@SemyonSinchenko
Copy link
Copy Markdown
Collaborator

What changes were proposed in this pull request?

  • python3 script to run only required benchmarks and collect results
  • update in LaikaCustoms and one of docs pages
  • updates in CI (docs)

Why are the changes needed?

It needs to be done :)

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR aims to fix the docs build pipeline by generating a stable, docs-oriented benchmarks/jmh-result.json and updating Laika/docs templates to consume benchmark results keyed by algorithm.

Changes:

  • Extend Laika benchmark JSON ingestion to key benchmark results by benchmarkName.algorithm (and keep legacy aliases for a subset).
  • Update the benchmarks documentation page to reference the new config key structure.
  • Add a dedicated dev/run_doc_benchmarks.py script and update the docs GitHub Actions workflow to use it.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
project/LaikaCustoms.scala Adds algorithm-aware benchmark keys and legacy aliasing when building Laika config from JMH JSON.
docs/src/01-about/03-benchmarks.md Updates template variables to the new benchmarkName.algorithm.* key paths.
dev/run_doc_benchmarks.py New helper to run only the benchmarks needed for docs and merge outputs into benchmarks/jmh-result.json.
benchmarks/src/main/scala/org/graphframes/benchmarks/ConnectedComponentsBenchmark.scala Expands benchmark parameterization to include randomized_contraction.
.github/workflows/docs.yml Switches docs workflow benchmarking step to use the new Python helper script.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread project/LaikaCustoms.scala Outdated
Comment thread docs/src/01-about/03-benchmarks.md
@SemyonSinchenko SemyonSinchenko merged commit af30013 into graphframes:main Apr 1, 2026
8 checks passed
@SemyonSinchenko SemyonSinchenko deleted the fix-docs-build branch April 1, 2026 21:13
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