Skip to content

docs: add guides on PR benchmark and cross-release benchmark#1475

Draft
JuroOravec wants to merge 2 commits into
airspeed-velocity:mainfrom
JuroOravec:jo-796-guides-on-github-integration
Draft

docs: add guides on PR benchmark and cross-release benchmark#1475
JuroOravec wants to merge 2 commits into
airspeed-velocity:mainfrom
JuroOravec:jo-796-guides-on-github-integration

Conversation

@JuroOravec
Copy link
Copy Markdown
Contributor

This PR documents integration with GitHub for these use cases:

  • Performance report on pull requests.
  • Benchmarking the package across releases.

I'm not sure how to run Sphinx locally, so I didn't check if the docs build, and if the images are linked correctly. But I at least used this website Documatt Snippets to ensure that the rst syntax is correct (I use markdown).

Closes #796

@mattip
Copy link
Copy Markdown
Contributor

mattip commented May 20, 2025

I did this to build the docs

pip install -e .      # to install asv
pip install asv[doc]  # to get the requirements
sphinx-build -W docs/source/ html

I don't understand why the CI did not run here.

@mattip
Copy link
Copy Markdown
Contributor

mattip commented May 20, 2025

I get a warning, why is the image unreadable is missing?

asv/docs/source/guide_pull_request.rst:17: \
    WARNING: image file not readable: _static/asv-report.png [image.not_readable]

@mattip
Copy link
Copy Markdown
Contributor

mattip commented May 20, 2025

LGTM (once the missing image is found). It might be nice to try to resolve some of the redundant information in the new docs and the existing user guide

@JuroOravec
Copy link
Copy Markdown
Contributor Author

Note to self - I'll have to update the docs / code - getting a github bot to comment on PRs was actually trickier because of permissions issues.

@JuroOravec JuroOravec marked this pull request as draft May 26, 2025 06:47
@mattip
Copy link
Copy Markdown
Contributor

mattip commented Dec 3, 2025

ping. This is really nice info, it would be good to get this in

@HaoZeke
Copy link
Copy Markdown
Member

HaoZeke commented Mar 8, 2026

Very nice! FWIW I recently setup https://asv-perch.rgoswami.me from similar considerations.

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.

Existing sample/recipe for integrating asv with github

3 participants