Skip to content

Commit

Permalink
DOC: Add links to examples and rework docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
HaoZeke committed Feb 11, 2024
1 parent cae6a9a commit 8a6072b
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
15 changes: 13 additions & 2 deletions docs/source/asv.conf.json.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,19 @@ The ``asv.conf.json`` file contains information about a particular
benchmarking project. The following describes each of the keys in
this file and their expected values.

.. note::

The GitHub repository at `asv_samples
<https://github.com/HaoZeke/asv_samples>`_ serves as a comprehensive
showcase for integrating Air Speed Velocity (ASV) with a wide array of
Python project configurations. This includes various build systems and
advanced benchmarking features like custom parameterizations and ASV
plugins, aiming to benchmark Python code performance across diverse setups.

The repository is structured with dedicated branches for each build system
and feature demonstration, providing insights into the impacts of different
build systems and ASV's extensible features on performance metrics.

.. only:: not man

.. contents::
Expand Down Expand Up @@ -95,8 +108,6 @@ environment.

If a build command is not specified in the ``asv.conf.json``, the default
assumes the build system requirements are defined in a ``setup.py`` file.
However, the ``asv.conf.json`` template also includes as a comment the
commands to build the project using a ``pyproject.toml`` file.
``pyproject.toml`` is the preferred file format to define the build system
requirements of Python projects (`PEP518
<https://peps.python.org/pep-0518/>`_), and this approach will be the
Expand Down
7 changes: 4 additions & 3 deletions docs/source/benchmarks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,11 @@ The following benchmark types are recognized:

.. note::

.. versionadded:: 0.6.0
.. versionadded:: 0.6.2

Users may define their own benchmark types, see ``asv_runner`` for
examples.
External benchmarks may be defined through ``asv_runner`` and a list of
benchmark plugins (like ``asv_bench_memray``) may be found here, with
samples at `asv_samples <https://github.com/HaoZeke/asv_samples>`_.

Benchmark attributes
--------------------
Expand Down

0 comments on commit 8a6072b

Please sign in to comment.