Skip to content

Commit 9d0558c

Browse files
committed
πŸ“ docs: add upstream links and logo
Link pyenv, mise, asdf, uv, and filelock to their upstream docs. Add SVG logo to the sidebar via furo theme options.
1 parent ff4517d commit 9d0558c

5 files changed

Lines changed: 26 additions & 7 deletions

File tree

β€Ždocs/_static/logo.svgβ€Ž

Lines changed: 11 additions & 0 deletions
Loading

β€Ždocs/conf.pyβ€Ž

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,8 @@
3737
html_last_updated_fmt = datetime.now(tz=timezone.utc).isoformat()
3838
pygments_dark_style = "monokai"
3939
html_show_sourcelink = False
40+
html_static_path = ["_static"]
41+
html_theme_options = {
42+
"light_logo": "logo.svg",
43+
"dark_logo": "logo.svg",
44+
}

β€Ždocs/explanation.rstβ€Ž

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,16 @@ py-discovery detects this and resolves it to the real binary.
5959
style Use fill:#4a9f4a,stroke:#2a6f2a,color:#fff
6060
style Skip fill:#d94a4a,stroke:#8f2a2a,color:#fff
6161

62-
For mise and asdf, the ``MISE_DATA_DIR`` and ``ASDF_DATA_DIR`` directories are searched. The shim directory is
63-
identified via the ``PYENV_ROOT``, ``MISE_DATA_DIR``, or ``ASDF_DATA_DIR`` environment variables.
62+
For `mise <https://mise.jdx.dev/>`_ and `asdf <https://asdf-vm.com/>`_, the ``MISE_DATA_DIR`` and ``ASDF_DATA_DIR``
63+
directories are searched. The shim directory is identified via the ``PYENV_ROOT``, ``MISE_DATA_DIR``, or
64+
``ASDF_DATA_DIR`` environment variables.
6465

6566
Cache design
6667
------------
6768

6869
The :class:`~py_discovery.DiskCache` stores interpreter metadata as JSON files under
69-
``<root>/py_info/4/<sha256>.json``, where the hash is derived from the interpreter path. File locking via ``filelock``
70+
``<root>/py_info/4/<sha256>.json``, where the hash is derived from the interpreter path. File locking via
71+
`filelock <https://py-filelock.readthedocs.io/>`_
7072
ensures safe concurrent access.
7173

7274
.. mermaid::
@@ -86,7 +88,7 @@ ensures safe concurrent access.
8688
The cache layer uses a :class:`typing.Protocol` (:class:`~py_discovery.PyInfoCache`), so any object with the right
8789
method signatures works as a cache backend -- no inheritance required. Two built-in implementations are provided:
8890

89-
- :class:`~py_discovery.DiskCache` -- persistent JSON + filelock storage.
91+
- :class:`~py_discovery.DiskCache` -- persistent JSON + `filelock <https://py-filelock.readthedocs.io/>`_ storage.
9092
- ``cache=None`` -- disables caching, useful for one-shot scripts or testing.
9193

9294
Spec format

β€Ždocs/how-to/standalone-usage.rstβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Implement the :class:`~py_discovery.PyInfoCache` protocol to provide your own st
5656
def py_info_clear(self) -> None: ...
5757
5858
The built-in :class:`~py_discovery.DiskCache` stores JSON files under ``<root>/py_info/4/<sha256>.json`` with
59-
``filelock``-based locking. Pass ``cache=None`` to disable caching entirely.
59+
`filelock <https://py-filelock.readthedocs.io/>`_-based locking. Pass ``cache=None`` to disable caching entirely.
6060

6161
Using ``get_interpreter`` directly
6262
-----------------------------------

β€Ždocs/index.rstβ€Ž

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@ py-discovery
22
============
33

44
A Python interpreter discovery library. ``py-discovery`` finds Python interpreters on your system by searching PATH,
5-
version managers (pyenv, mise, asdf), the Windows registry (:pep:`514`), and uv-managed installations. Results are cached
6-
to disk for fast repeated lookups.
5+
version managers (`pyenv <https://github.com/pyenv/pyenv>`_, `mise <https://mise.jdx.dev/>`_,
6+
`asdf <https://asdf-vm.com/>`_), the Windows registry (:pep:`514`), and `uv <https://docs.astral.sh/uv/>`_-managed
7+
installations. Results are cached to disk for fast repeated lookups.
78

89
.. toctree::
910
:caption: Tutorials

0 commit comments

Comments
Β (0)