executiontimer 1.0.1__tar.gz → 1.0.3__tar.gz

{executiontimer-1.0.1 → executiontimer-1.0.3}/.gitignore

@@ -17,3 +17,4 @@ dist/
 .DS_Store
 .coverage
 htmlcov/
+docs/_build/

{executiontimer-1.0.1 → executiontimer-1.0.3}/CHANGELOG.md

@@ -7,6 +7,51 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.3] - 2026-09-30
+
+### Changed
+
+- Entering and exiting a section is 20–25% faster, about 0.25 µs less per section on
+  CPython 3.14. Each active section's state is now a plain tuple rather than a named
+  tuple, whose constructor cost more than the rest of section entry. Behaviour is
+  unchanged.
+
+### Documentation
+
+- A documentation site at <https://seba2390.github.io/ExecutionTimer/>, with a getting
+  started guide, a user guide and an API reference generated from the docstrings. It is
+  built with Sphinx and deployed to GitHub Pages whenever `main` changes. The package's
+  `Documentation` link points to it from this release on.
+- The README is shorter and links to the site for details.
+- Public functions and types have full docstrings, with parameters, return values and
+  exceptions.
+- The Python examples in the README and the documentation run as part of the test suite,
+  and CI builds the site on every pull request, failing on any warning.
+- Refresh the overhead benchmark, comparing 0.1.0, 1.0.2 and 1.0.3.
+
+## [1.0.2] - 2026-09-30
+
+### Fixed
+
+- Decorating a function that returns a coroutine, typically because another decorator
+  sits between `TimerContext` and an `async def`, now times the `await`. Previously the
+  section recorded only the call that created the coroutine, a few microseconds however
+  long the coroutine ran. Other awaitables, such as futures and tasks, are returned
+  unchanged.
+
+### Changed
+
+- The test suite fails on any warning, and CI requires 100% statement and branch coverage
+  rather than 95%.
+
+### Documentation
+
+- Note that flattening also merges sections whose own names end in an integer, such as
+  `"row[1]"` and `"row[2]"`.
+- The release steps in the contributing guide describe the pull-request flow that the
+  protected `main` branch requires.
+- Refresh the overhead benchmark against version 1.0.2.
+
 ## [1.0.1] - 2026-09-30
 
 ### Fixed
@@ -149,7 +194,9 @@ First public release on PyPI.
   `py.typed` marker so type checkers use the inline annotations.
 - `__version__` attribute on the package.
 
-[Unreleased]: https://github.com/seba2390/ExecutionTimer/compare/v1.0.1...HEAD
+[Unreleased]: https://github.com/seba2390/ExecutionTimer/compare/v1.0.3...HEAD
+[1.0.3]: https://github.com/seba2390/ExecutionTimer/compare/v1.0.2...v1.0.3
+[1.0.2]: https://github.com/seba2390/ExecutionTimer/compare/v1.0.1...v1.0.2
 [1.0.1]: https://github.com/seba2390/ExecutionTimer/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/seba2390/ExecutionTimer/compare/v0.2.0...v1.0.0
 [0.2.0]: https://github.com/seba2390/ExecutionTimer/compare/v0.1.1...v0.2.0

{executiontimer-1.0.1 → executiontimer-1.0.3}/CONTRIBUTING.md

@@ -23,8 +23,8 @@ uv run ruff format
 uv run basedpyright
 ```
 
-All four must pass. Coverage is enforced at 95%; the current suite has 100% statement
-and branch coverage. Preserve coverage when adding or changing behavior.
+All four must pass. The suite has 100% statement and branch coverage, and CI enforces it.
+Any warning raised during the tests fails them.
 
 The test suite is also run against Python 3.11, 3.12, 3.13, 3.14 and free-threaded 3.14t
 on Linux, macOS and Windows.
@@ -41,16 +41,32 @@ machine and Python version, without coverage instrumentation:
 uv run python benchmarks/overhead.py --number 100000 --repeat 9
 ```
 
-See [benchmarks/README.md](benchmarks/README.md) for methodology and reference results.
+See [benchmarks/README.md](https://github.com/seba2390/ExecutionTimer/blob/main/benchmarks/README.md) for methodology and reference results.
 Timing results are advisory rather than CI pass/fail thresholds.
 
+## Documentation
+
+The documentation site is built with [Sphinx](https://www.sphinx-doc.org/) from the
+Markdown pages in `docs/` and the docstrings in `src/`. To build and preview it:
+
+```bash
+uv run --group docs sphinx-build -M html docs docs/_build -W --keep-going -n
+```
+
+Then open `docs/_build/html/index.html`. CI builds the site on every pull request and fails
+on any warning, such as a broken cross-reference. Changes merged into `main` are published
+to [GitHub Pages](https://seba2390.github.io/ExecutionTimer/) automatically.
+
+The Python examples in `docs/` and `README.md` run as part of the test suite, so keep them
+self-contained and runnable.
+
 ## Guidelines
 
 - Tests exercise the **public API** only — import from `execution_timer`, not
   `execution_timer._timer`. This keeps internals free to change.
 - Every behaviour change needs a test that fails before the fix and passes after it.
 - Public functions carry type annotations and a one-line docstring.
-- Add an entry under `## [Unreleased]` in [CHANGELOG.md](CHANGELOG.md).
+- Add an entry under `## [Unreleased]` in [CHANGELOG.md](https://github.com/seba2390/ExecutionTimer/blob/main/CHANGELOG.md).
 
 ## Releasing
 
@@ -63,11 +79,12 @@ Maintainers only:
 3. Run the checks above, build with `uv build`, and validate metadata with
    `uvx twine check --strict dist/*`. Use a clean output directory so old versions are
    not included in release artifacts.
-4. Commit, then push to `main` and wait for CI to pass.
-5. Publish a GitHub release tagged `vX.Y.Z`, targeting the validated commit on `main`.
+4. Commit on a branch and open a pull request. `main` is protected: it only accepts
+   pull requests whose `CI passed` check succeeds. Squash-merge once CI is green.
+5. Publish a GitHub release tagged `vX.Y.Z`, targeting the merged commit on `main`.
    Use that version's changelog entries as release notes.
 
-The [Publish to PyPI workflow](.github/workflows/publish.yml) runs when a GitHub release
+The [Publish to PyPI workflow](https://github.com/seba2390/ExecutionTimer/blob/main/.github/workflows/publish.yml) runs when a GitHub release
 is **published**. Pushing to `main`, pushing a tag alone, or saving a draft release does
 not trigger it. The workflow builds and validates the distributions, checks that the tag
 matches `__version__`, and uploads them to PyPI via Trusted Publishing. No manual

executiontimer-1.0.3/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.5
+Name: executiontimer
+Version: 1.0.3
+Summary: Hierarchical execution timing with user-defined categories.
+Project-URL: Homepage, https://github.com/seba2390/ExecutionTimer
+Project-URL: Documentation, https://seba2390.github.io/ExecutionTimer/
+Project-URL: Repository, https://github.com/seba2390/ExecutionTimer
+Project-URL: Issues, https://github.com/seba2390/ExecutionTimer/issues
+Project-URL: Changelog, https://github.com/seba2390/ExecutionTimer/blob/main/CHANGELOG.md
+Author: Sebastian Yde Madsen
+License-Expression: MIT
+License-File: LICENSE
+Keywords: benchmark,context-manager,decorator,execution-time,instrumentation,performance,profiling,timing
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Free Threading :: 3 - Stable
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Benchmark
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/seba2390/ExecutionTimer/main/assets/logo-dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/seba2390/ExecutionTimer/main/assets/logo-light.svg">
+    <img src="https://raw.githubusercontent.com/seba2390/ExecutionTimer/main/assets/logo-light.svg" alt="executiontimer" width="520">
+  </picture>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/executiontimer/"><img src="https://img.shields.io/pypi/v/executiontimer?color=blue" alt="PyPI version"></a>
+  <a href="https://pypi.org/project/executiontimer/"><img src="https://img.shields.io/pypi/pyversions/executiontimer" alt="Python versions"></a>
+  <a href="https://github.com/seba2390/ExecutionTimer/actions/workflows/ci.yml"><img src="https://github.com/seba2390/ExecutionTimer/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://github.com/seba2390/ExecutionTimer/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green" alt="License"></a>
+  <a href="https://seba2390.github.io/ExecutionTimer/"><img src="https://img.shields.io/badge/docs-GitHub%20Pages-4F46E5" alt="Documentation"></a>
+</p>
+
+Time named sections of your code with a `with` block or a decorator. Sections nested inside
+each other form a tree, so you see where the time actually went, not just one number at the
+end.
+
+Zero dependencies. Fully typed. Works with threads and `asyncio`.
+
+## Documentation 
+[seba2390.github.io/ExecutionTimer](https://seba2390.github.io/ExecutionTimer/)
+
+## Installation
+
+```bash
+pip install executiontimer
+```
+
+Requires Python 3.11+. The install name is `executiontimer`; the import name is
+`execution_timer`.
+
+## Quick start
+
+```python
+import time
+
+from execution_timer import TimerContext, get_execution_times_report
+
+with TimerContext("load_data"):
+    time.sleep(0.12)
+
+with TimerContext("solve"):
+    for i in range(3):
+        with TimerContext("step", category="gpu", counter=i):
+            time.sleep(0.05)
+    with TimerContext("postprocess", category="cpu"):
+        time.sleep(0.03)
+
+print(get_execution_times_report())
+```
+
+```text
+Total time: 0.3156 s.
+
+load_data: 0.1219 s (38.62%)
+solve: 0.1937 s (61.38%)
+..  step: 0.1585 s (50.24%)
+..  postprocess: 0.0350 s (11.10%)
+```
+
+`TimerContext` also works as a decorator, including on `async def` functions:
+
+```python
+@TimerContext("preprocess")
+def preprocess(rows: list[str]) -> list[str]:
+    return [row.strip() for row in rows]
+```
+
+## Learn more
+
+- [Getting started](https://seba2390.github.io/ExecutionTimer/getting-started.html)
+- User guide: [timing code](https://seba2390.github.io/ExecutionTimer/guide/timing-code.html),
+  [counters](https://seba2390.github.io/ExecutionTimer/guide/counters.html),
+  [categories](https://seba2390.github.io/ExecutionTimer/guide/categories.html),
+  [reports and JSON export](https://seba2390.github.io/ExecutionTimer/guide/reports.html),
+  [threads, asyncio and generators](https://seba2390.github.io/ExecutionTimer/guide/concurrency.html)
+- [API reference](https://seba2390.github.io/ExecutionTimer/api.html)
+- [Changelog](https://github.com/seba2390/ExecutionTimer/blob/main/CHANGELOG.md) and
+  [contributing guide](https://github.com/seba2390/ExecutionTimer/blob/main/CONTRIBUTING.md)
+
+## License
+
+MIT — see [LICENSE](https://github.com/seba2390/ExecutionTimer/blob/main/LICENSE).

executiontimer-1.0.3/README.md

@@ -0,0 +1,86 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/seba2390/ExecutionTimer/main/assets/logo-dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/seba2390/ExecutionTimer/main/assets/logo-light.svg">
+    <img src="https://raw.githubusercontent.com/seba2390/ExecutionTimer/main/assets/logo-light.svg" alt="executiontimer" width="520">
+  </picture>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/executiontimer/"><img src="https://img.shields.io/pypi/v/executiontimer?color=blue" alt="PyPI version"></a>
+  <a href="https://pypi.org/project/executiontimer/"><img src="https://img.shields.io/pypi/pyversions/executiontimer" alt="Python versions"></a>
+  <a href="https://github.com/seba2390/ExecutionTimer/actions/workflows/ci.yml"><img src="https://github.com/seba2390/ExecutionTimer/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://github.com/seba2390/ExecutionTimer/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green" alt="License"></a>
+  <a href="https://seba2390.github.io/ExecutionTimer/"><img src="https://img.shields.io/badge/docs-GitHub%20Pages-4F46E5" alt="Documentation"></a>
+</p>
+
+Time named sections of your code with a `with` block or a decorator. Sections nested inside
+each other form a tree, so you see where the time actually went, not just one number at the
+end.
+
+Zero dependencies. Fully typed. Works with threads and `asyncio`.
+
+## Documentation 
+[seba2390.github.io/ExecutionTimer](https://seba2390.github.io/ExecutionTimer/)
+
+## Installation
+
+```bash
+pip install executiontimer
+```
+
+Requires Python 3.11+. The install name is `executiontimer`; the import name is
+`execution_timer`.
+
+## Quick start
+
+```python
+import time
+
+from execution_timer import TimerContext, get_execution_times_report
+
+with TimerContext("load_data"):
+    time.sleep(0.12)
+
+with TimerContext("solve"):
+    for i in range(3):
+        with TimerContext("step", category="gpu", counter=i):
+            time.sleep(0.05)
+    with TimerContext("postprocess", category="cpu"):
+        time.sleep(0.03)
+
+print(get_execution_times_report())
+```
+
+```text
+Total time: 0.3156 s.
+
+load_data: 0.1219 s (38.62%)
+solve: 0.1937 s (61.38%)
+..  step: 0.1585 s (50.24%)
+..  postprocess: 0.0350 s (11.10%)
+```
+
+`TimerContext` also works as a decorator, including on `async def` functions:
+
+```python
+@TimerContext("preprocess")
+def preprocess(rows: list[str]) -> list[str]:
+    return [row.strip() for row in rows]
+```
+
+## Learn more
+
+- [Getting started](https://seba2390.github.io/ExecutionTimer/getting-started.html)
+- User guide: [timing code](https://seba2390.github.io/ExecutionTimer/guide/timing-code.html),
+  [counters](https://seba2390.github.io/ExecutionTimer/guide/counters.html),
+  [categories](https://seba2390.github.io/ExecutionTimer/guide/categories.html),
+  [reports and JSON export](https://seba2390.github.io/ExecutionTimer/guide/reports.html),
+  [threads, asyncio and generators](https://seba2390.github.io/ExecutionTimer/guide/concurrency.html)
+- [API reference](https://seba2390.github.io/ExecutionTimer/api.html)
+- [Changelog](https://github.com/seba2390/ExecutionTimer/blob/main/CHANGELOG.md) and
+  [contributing guide](https://github.com/seba2390/ExecutionTimer/blob/main/CONTRIBUTING.md)
+
+## License
+
+MIT — see [LICENSE](https://github.com/seba2390/ExecutionTimer/blob/main/LICENSE).

executiontimer-1.0.3/benchmarks/README.md

@@ -0,0 +1,41 @@
+# Overhead benchmarks
+
+From a repository checkout, run:
+
+```bash
+uv run python benchmarks/overhead.py --number 100000 --repeat 9
+```
+
+The script prints JSON with the Python version, platform, and median nanoseconds per
+operation. Recording cases run `--number` operations per repeat. Reporting cases run
+`max(1, number // 1000)` operations against 1,000 recorded counter variants with ten
+categories. Async calls run in one event loop, so loop startup is excluded.
+
+Compare the same interpreter and machine under similar load, without coverage or a
+profiler enabled. These are microbenchmarks, not CI timing thresholds. The no-op bodies
+make instrumentation costs visible; application speedups depend on the work being timed.
+
+## Local comparison
+
+Measured on macOS 26.6.2, ARM64, CPython 3.14.5, using 100,000 operations and nine repeats.
+The baseline is commit `008494c` (version 0.1.0). All three versions ran the same script,
+one after the other. Values below are microseconds per operation and include the benchmark
+function call; plain calls cost approximately 0.02 µs and plain awaits 0.06 µs in every
+run. The last column compares 1.0.3 with the baseline.
+
+| Operation | 0.1.0 (µs) | 1.0.2 (µs) | 1.0.3 (µs) | Reduction |
+| --- | ---: | ---: | ---: | ---: |
+| New context | 1.604 | 1.116 | 0.877 | 45% |
+| Reused context | 1.433 | 1.013 | 0.786 | 45% |
+| Decorated call | 1.656 | 1.220 | 0.897 | 46% |
+| Decorated await | 1.800 | 1.197 | 0.948 | 47% |
+| Five nested contexts | 8.238 | 5.782 | 4.371 | 47% |
+| Total time, 1,000 sections | 522.668 | 43.786 | 43.630 | 92% |
+| JSON, 1,000 sections | 1,255.098 | 1,139.416 | 1,065.708 | 15% |
+| Disabled logging, 1,000 sections | 530.408 | 0.100 | 0.100 | >99.9% |
+
+Recording keeps each invocation's start time and cached path in a context-local frame,
+stored as a plain tuple because a named tuple's constructor costs more than the rest of
+entering a section. Decorators reuse their context instead of constructing one per call.
+Total-time queries avoid copying and flattening entries, JSON exports share one snapshot,
+and disabled logging returns before building a report.

executiontimer-1.0.3/docs/_static/icon-dark.svg

@@ -0,0 +1,34 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="14 10 112 112" width="112" height="112" role="img" aria-label="executiontimer">
+  <title>executiontimer</title>
+  <defs>
+    <linearGradient id="ring1" x1="0" y1="0" x2="1" y2="1">
+      <stop offset="0%" stop-color="#818CF8"/>
+      <stop offset="100%" stop-color="#4F46E5"/>
+    </linearGradient>
+    <linearGradient id="ring2" x1="0" y1="0" x2="1" y2="1">
+      <stop offset="0%" stop-color="#C084FC"/>
+      <stop offset="100%" stop-color="#9333EA"/>
+    </linearGradient>
+    <linearGradient id="ring3" x1="0" y1="0" x2="1" y2="1">
+      <stop offset="0%" stop-color="#22D3EE"/>
+      <stop offset="100%" stop-color="#0891B2"/>
+    </linearGradient>
+  </defs>
+
+  <!-- Stopwatch stem and crown -->
+  <rect x="62" y="16" width="16" height="14" rx="4" fill="#94A3B8"/>
+  <rect x="55" y="10" width="30" height="9" rx="4.5" fill="#94A3B8"/>
+
+  <!-- Unfilled tracks -->
+  <circle cx="70" cy="76" r="42" fill="none" stroke="#334155" stroke-width="8"/>
+  <circle cx="70" cy="76" r="31" fill="none" stroke="#334155" stroke-width="8"/>
+  <circle cx="70" cy="76" r="20" fill="none" stroke="#334155" stroke-width="8"/>
+
+  <!-- Nested arcs: each ring is one level of the timing hierarchy -->
+  <g fill="none" stroke-width="8" stroke-linecap="round">
+    <path d="M 70 34 A 42 42 0 1 1 28.64 83.29" stroke="url(#ring1)"/>
+    <path d="M 70 45 A 31 31 0 1 1 64.62 106.53" stroke="url(#ring2)"/>
+    <path d="M 70 56 A 20 20 0 0 1 80 93.32" stroke="url(#ring3)"/>
+  </g>
+
+</svg>

executiontimer-1.0.3/docs/_static/icon-light.svg

@@ -0,0 +1,34 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="14 10 112 112" width="112" height="112" role="img" aria-label="executiontimer">
+  <title>executiontimer</title>
+  <defs>
+    <linearGradient id="ring1" x1="0" y1="0" x2="1" y2="1">
+      <stop offset="0%" stop-color="#818CF8"/>
+      <stop offset="100%" stop-color="#4F46E5"/>
+    </linearGradient>
+    <linearGradient id="ring2" x1="0" y1="0" x2="1" y2="1">
+      <stop offset="0%" stop-color="#C084FC"/>
+      <stop offset="100%" stop-color="#9333EA"/>
+    </linearGradient>
+    <linearGradient id="ring3" x1="0" y1="0" x2="1" y2="1">
+      <stop offset="0%" stop-color="#22D3EE"/>
+      <stop offset="100%" stop-color="#0891B2"/>
+    </linearGradient>
+  </defs>
+
+  <!-- Stopwatch stem and crown -->
+  <rect x="62" y="16" width="16" height="14" rx="4" fill="#475569"/>
+  <rect x="55" y="10" width="30" height="9" rx="4.5" fill="#475569"/>
+
+  <!-- Unfilled tracks -->
+  <circle cx="70" cy="76" r="42" fill="none" stroke="#E2E8F0" stroke-width="8"/>
+  <circle cx="70" cy="76" r="31" fill="none" stroke="#E2E8F0" stroke-width="8"/>
+  <circle cx="70" cy="76" r="20" fill="none" stroke="#E2E8F0" stroke-width="8"/>
+
+  <!-- Nested arcs: each ring is one level of the timing hierarchy -->
+  <g fill="none" stroke-width="8" stroke-linecap="round">
+    <path d="M 70 34 A 42 42 0 1 1 28.64 83.29" stroke="url(#ring1)"/>
+    <path d="M 70 45 A 31 31 0 1 1 64.62 106.53" stroke="url(#ring2)"/>
+    <path d="M 70 56 A 20 20 0 0 1 80 93.32" stroke="url(#ring3)"/>
+  </g>
+
+</svg>

executiontimer-1.0.3/docs/api.md

@@ -0,0 +1,72 @@
+# API reference
+
+Everything below is importable from `execution_timer`. The public API follows
+[semantic versioning](https://semver.org/): it only changes incompatibly in a new major
+version.
+
+```python
+from execution_timer import TimerContext, get_execution_times_report
+```
+
+## Timing
+
+```{eval-rst}
+.. autoclass:: execution_timer.TimerContext
+   :special-members: __call__
+
+.. py:data:: execution_timer.DEFAULT_CATEGORY
+   :type: str
+   :value: "default"
+
+   The category of sections created without one.
+```
+
+## Reports
+
+```{eval-rst}
+.. autofunction:: execution_timer.get_execution_times_report
+.. autofunction:: execution_timer.log_execution_times
+.. autofunction:: execution_timer.get_execution_timings
+.. autofunction:: execution_timer.get_total_time
+.. autofunction:: execution_timer.get_total_category_time
+```
+
+## JSON export
+
+```{eval-rst}
+.. autofunction:: execution_timer.get_execution_times_json
+.. autofunction:: execution_timer.save_execution_timings_json
+```
+
+## Managing timings and rules
+
+```{eval-rst}
+.. autofunction:: execution_timer.clear_execution_timings
+.. autofunction:: execution_timer.register_forbidden_nesting
+.. autofunction:: execution_timer.clear_forbidden_nesting
+```
+
+## Types
+
+These are {class}`~typing.TypedDict` classes: at runtime the values are plain
+dictionaries, and the classes exist for type checkers.
+
+```{eval-rst}
+.. autoclass:: execution_timer.TimingReport
+   :members:
+
+.. autoclass:: execution_timer.TimingsPayload
+   :members:
+
+.. autoclass:: execution_timer.SectionRecord
+   :members:
+```
+
+## Version
+
+```{eval-rst}
+.. py:data:: execution_timer.__version__
+   :type: str
+
+   The installed version, for example ``"1.0.2"``.
+```

executiontimer-1.0.3/docs/changelog.md

@@ -0,0 +1,2 @@
+```{include} ../CHANGELOG.md
+```

executiontimer-1.0.3/docs/conf.py

@@ -0,0 +1,90 @@
+"""Sphinx configuration for the executiontimer documentation."""
+
+from datetime import date
+
+import execution_timer
+
+project = "executiontimer"
+author = "Sebastian Yde Madsen"
+copyright = f"{date.today().year}, {author}"
+release = execution_timer.__version__
+version = release
+
+extensions = [
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinx_copybutton",
+    "sphinx_design",
+]
+
+exclude_patterns = ["_build"]
+nitpicky = True
+
+# Markdown pages
+myst_enable_extensions = ["colon_fence", "deflist", "fieldlist"]
+myst_heading_anchors = 3
+
+# API reference
+autodoc_member_order = "bysource"
+autodoc_typehints = "description"
+autodoc_typehints_description_target = "documented"
+autodoc_preserve_defaults = True
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
+napoleon_use_rtype = False
+intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
+
+# Type variables in decorator signatures have no page of their own.
+nitpick_ignore_regex = [("py:class", r"(~|execution_timer\._timer\.)?[PRT]")]
+
+# HTML output
+# The GitHub mark from Primer Octicons (mark-github-16).
+_GITHUB_MARK = (
+    '<svg fill="currentColor" viewBox="0 0 16 16"><path d="'
+    "M6.766 11.328c-2.063-.25-3.516-1.734-3.516-3.656 0-.781.281-1.625.75-2.188-.203-.515-.172-"
+    "1.609.063-2.062.625-.078 1.468.25 1.968.703.594-.187 1.219-.281 1.985-.281.765 0 1.39.094 "
+    "1.953.265.484-.437 1.344-.765 1.969-.687.218.422.25 1.515.046 2.047.5.593.766 1.39.766 2.2"
+    "03 0 1.922-1.453 3.375-3.547 3.64.531.344.89 1.094.89 1.954v1.625c0 .468.391.734.86.547C13"
+    ".781 14.359 16 11.53 16 8.03 16 3.61 12.406 0 7.984 0 3.563 0 0 3.61 0 8.031a7.88 7.88 0 0"
+    " 0 5.172 7.422c.422.156.828-.125.828-.547v-1.25c-.219.094-.5.156-.75.156-1.031 0-1.64-.562"
+    "-2.078-1.609-.172-.422-.36-.672-.719-.719-.187-.015-.25-.093-.25-.187 0-.188.313-.328.625-"
+    ".328.453 0 .844.281 1.25.86.313.452.64.655 1.031.655s.641-.14 1-.5c.266-.265.47-.5.657-.65"
+    "6"
+    '"/></svg>'
+)
+
+html_theme = "furo"
+html_title = "executiontimer"
+html_static_path = ["_static"]
+html_favicon = "_static/icon-light.svg"
+html_copy_source = False
+html_show_sourcelink = False
+html_theme_options = {
+    "light_logo": "icon-light.svg",
+    "dark_logo": "icon-dark.svg",
+    "source_repository": "https://github.com/seba2390/ExecutionTimer/",
+    "source_branch": "main",
+    "source_directory": "docs/",
+    "light_css_variables": {
+        "color-brand-primary": "#4F46E5",
+        "color-brand-content": "#4F46E5",
+        "color-brand-visited": "#4F46E5",
+    },
+    "dark_css_variables": {
+        "color-brand-primary": "#818CF8",
+        "color-brand-content": "#818CF8",
+        "color-brand-visited": "#818CF8",
+    },
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/seba2390/ExecutionTimer",
+            "html": _GITHUB_MARK,
+            "class": "",
+        },
+    ],
+}
+copybutton_exclude = ".linenos, .gp, .go"

executiontimer-1.0.3/docs/contributing.md

@@ -0,0 +1,2 @@
+```{include} ../CONTRIBUTING.md
+```